drizzle 1.15.3__tar.gz → 2.0.0__tar.gz

drizzle-2.0.0/.clang-format

@@ -0,0 +1,17 @@
+---
+BasedOnStyle: Google
+Language: Cpp
+AlwaysBreakAfterReturnType: None
+AlwaysBreakAfterDefinitionReturnType: TopLevel
+DerivePointerAlignment: false
+PointerAlignment: Right
+SortIncludes: false
+SortUsingDeclarations: false
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+AlignConsecutiveMacros: true
+ReflowComments: true
+SpaceBeforeParens: ControlStatements
+
+...

drizzle-2.0.0/.coveragerc

@@ -0,0 +1,32 @@
+[run]
+source = drizzle
+
+omit =
+    drizzle/__init__*
+    drizzle/**/conftest.py
+    drizzle/**/setup*
+    drizzle/**/tests/*
+    drizzle/version*
+    drizzle/_version.py
+    */drizzle/__init__*
+    */drizzle/**/conftest.py
+    */drizzle/**/setup*
+    */drizzle/**/tests/*
+
+[report]
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about packages we have installed
+    except ImportError
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain about script hooks
+    'def main(.*):'
+
+    # Ignore branches that don't pertain to this version of Python
+    pragma: py{ignore_python_version}

drizzle-2.0.0/.flake8

@@ -0,0 +1,13 @@
+[flake8]
+max-line-length = 100
+select = F, W, E, C
+ignore =
+    # Line break occurred before a binary operator
+    W503,
+    # Line break occurred after a binary operator
+    W504,
+exclude =
+    docs,
+    build
+    .eggs,
+    .tox,

drizzle-2.0.0/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - '*.x'
+    tags:
+      - "*"
+  pull_request:
+  schedule:
+    - cron: '0 6 * * 1'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    with:
+      envs: |
+        - linux: check-style
+        - linux: check-security
+
+        - linux: py310-xdist
+        - linux: py311-xdist
+        - linux: py313-xdist
+        - macos: py312-xdist
+        - windows: py312-xdist
+        - linux: py312-xdist-cov
+          coverage: codecov
+
+        - linux: py312-xdist-devdeps

drizzle-2.0.0/.ruff.toml

@@ -0,0 +1,211 @@
+extend = "pyproject.toml"
+lint.ignore = [
+    # flake8-annotations (ANN) : static typing
+    "ANN001",  # Function argument without type annotation
+    "ANN003",  # `**kwargs` without type annotation
+    "ANN202",  # Private function without return type annotation
+    "ANN401",  # Use of `Any` type
+
+    # flake8-unused-arguments (ARG)
+    "ARG001",  # unused-function-argument
+    "ARG002",  # unused-method-argument
+    "ARG003",  # unused-class-method-argument
+    "ARG004",  # unused-static-method-argument
+    "ARG005",  # unused-lambda-argument
+
+    # flake8-bugbear (B)
+    "B006",  # MutableArgumentDefault
+    "B007",  # UnusedLoopControlVariable
+    "B023",  # FunctionUsesLoopVariable
+    "B028",  # No-explicit-stacklevel
+    "B904",  # RaiseWithoutFromInsideExcept
+    "B905",  # ZipWithoutExplicitStrict   # requires 3.10+
+
+    # flake8-blind-except (BLE)
+    "BLE001",  # blind-except
+
+    # mccabe (C90) : code complexity
+    # TODO: configure maximum allowed complexity.
+    "C901",  # McCabeComplexity
+
+    # pydocstyle (D)
+    # Missing Docstrings
+    "D100",  # undocumented-public-module
+    "D101",  # undocumented-public-class
+    "D103",  # undocumented-public-function
+    "D104",  # undocumented-public-package
+    "D205",  # blank-line-after-summary
+    # Quotes Issues
+    "D300",  # triple-single-quotes
+    "D301",  # escape-sequence-in-docstring
+    # Docstring Content Issues
+    "D403",  # first-line-capitalized
+    "D404",  # docstring-starts-with-this
+    "D401",  # non-imperative-mood.
+    "D414",  # empty-docstring-section
+    "D419",  # docstring is empty
+
+    # flake8-datetimez (DTZ)
+    "DTZ001",  # call-datetime-without-tzinfo
+    "DTZ005",  # call-datetime-now-without-tzinfo
+
+    # pycodestyle (E, W)
+    "E501",  # line-too-long
+    "E721",  # type-comparison
+    "E731",  # lambda-assignment
+
+    # flake8-errmsg (EM)  : nicer error tracebacks
+    "EM101",   # raw-string-in-exception
+    "EM102",   # f-string-in-exception
+    "EM103",   # dot-format-in-exception
+
+    # eradicate (ERA)
+    # NOTE: be careful that developer notes are kept.
+    "ERA001",  # commented-out-code
+
+    # flake8-executable (EXE)
+    "EXE002",  # shebang-missing-executable-file
+
+    # Pyflakes (F)
+    "F841",  # unused-variable
+
+    # flake8-boolean-trap (FBT)  : boolean flags should be kwargs, not args
+    # NOTE: a good thing to fix, but changes API.
+    "FBT001",  # boolean-positional-arg-in-function-definition
+    "FBT002",  # boolean-default-value-in-function-definition
+    "FBT003",  # boolean-positional-value-in-function-call
+
+    # flake8-fixme (FIX)
+    "FIX001",  # Line contains FIXME.  this should be fixed or at least FIXME replaced with TODO
+    "FIX004",  # Line contains HACK. replace HACK with NOTE.
+
+    # pep8-naming (N)
+    # NOTE: some of these can/should be fixed, but this changes the API.
+    "N801",  # invalid-class-name
+    "N802",  # invalid-function-name
+    "N803",  # invalid-argument-name
+    "N804",  # invalid-first-argument-name-for-class-method
+    "N805",  # invalid-first-argument-name-for-method
+    "N807",  # dunder-function-name
+    "N813",  # camelcase-imported-as-lowercase
+    "N815",  # mixed-case-variable-in-class-scope
+    "N816",  # mixed-case-variable-in-global-scope
+    "N818",  # error-suffix-on-exception-name
+
+    # NumPy-specific rules (NPY)
+    "NPY002", # Replace legacy `np.random.rand` call with `np.random.Generator`  (2023-05-03)
+
+    # Perflint (PERF)
+    "PERF203",  # `try`-`except` within a loop incurs performance overhead
+    "PERF401",  # Use a list comprehension to create a transformed list
+
+    # Pylint (PLC, PLE, PLR, PLW)
+    "PLE0101",  # return-in-init
+    "PLR0124",  # Name compared with itself
+    "PLR0402",  # ConsiderUsingFromImport
+    "PLR0912",  # too-many-branches
+    "PLR0913",  # too-many-args
+    "PLR0915",  # too-many-statements
+    "PLR1714",  # Consider merging multiple comparisons
+    "PLR2004",  # MagicValueComparison
+    "PLR5501",  # collapsible-else-if
+    "PLW0603",  # global-statement
+    "PLW2901",  # redefined-loop-name
+
+    # flake8-pytest-style (PT)
+    "PT001",   # pytest-fixture-incorrect-parentheses-style
+    "PT003",   # pytest-extraneous-scope-function
+    "PT004",   # pytest-missing-fixture-name-underscore
+    "PT006",   # pytest-parametrize-names-wrong-type
+    "PT007",   # pytest-parametrize-values-wrong-type
+    "PT011",   # pytest-raises-too-broad
+    "PT012",   # pytest-raises-with-multiple-statements
+    "PT017",   # pytest-assert-in-exceptinstead
+    "PT018",   # pytest-composite-assertion
+    "PT022",   # pytest-useless-yield-fixture
+    "PT023",   # pytest-incorrect-mark-parentheses-style
+
+    # flake8-use-pathlib (PTH)
+    "PTH100",  # os-path-abspath
+    "PTH101",  # os-chmod
+    "PTH102",  # os-mkdir
+    "PTH103",  # os-makedirs
+    "PTH104",  # os-rename
+    "PTH107",  # os-remove
+    "PTH108",  # os-unlink
+    "PTH109",  # os-getcwd
+    "PTH110",  # os-path-exists
+    "PTH111",  # os-path-expanduser
+    "PTH112",  # os-path-isdir
+    "PTH113",  # os-path-isfile
+    "PTH118",  # os-path-join
+    "PTH119",  # os-path-basename
+    "PTH120",  # os-path-dirname
+    "PTH122",  # os-path-splitext
+    "PTH123",  # builtin-open
+    "PTH202",  # `os.path.getsize` should be replaced by `Path.stat().st_size`
+    "PTH207",  # Replace `glob` with `Path.glob` or `Path.rglob`
+
+    # flake8-return (RET)
+    "RET501",  # unnecessary-return-none
+    "RET502",  # implicit-return-value
+    "RET503",  # implicit-return
+    "RET504",  # unnecessary-assign
+    "RET507",  # superfluous-else-continue
+
+    # flake8-raise (RSE)
+    "RSE102",  # unnecessary-paren-on-raise-exception
+
+    # Ruff-specific rules (RUF)
+    "RUF001",  # ambiguous-unicode-character-string
+    "RUF002",  # ambiguous-unicode-character-docstring
+    "RUF010",  # use conversion in f-string
+    "RUF012",  # Mutable class attributes should be annotated with `typing.ClassVar`
+
+    # flake8-bandit (S)
+    "S101",  # Use of `assert` detected
+    "S105",  # hardcoded-password-string
+    "S110",  # try-except-pass
+    "S112",  # try-except-continue
+    "S301",  # suspicious-pickle-usage
+    "S307",  # Use of possibly insecure function; consider using `ast.literal_eval`
+    "S311",  # suspicious-non-cryptographic-randomness
+    "S324",  # hashlib-insecure-hash-function
+    "S506",  # UnsafeYAMLLoad
+    "S310",  # Suspicious-url-open-usage
+    "S603",  # `subprocess` call: check for execution of untrusted input
+    "S607",  # Starting a process with a partial executable path
+
+    # flake8-simplify (SIM)
+    "SIM102",  # NestedIfStatements
+    "SIM105",  # UseContextlibSuppress
+    "SIM108",  # UseTernaryOperator
+    "SIM114",  # if-with-same-arms
+    "SIM115",  # OpenFileWithContextHandler
+    "SIM117",  # MultipleWithStatements
+    "SIM118",  # KeyInDict
+    "SIM201",  # NegateEqualOp
+    "SIM300",  # yoda condition
+
+    # flake8-print (T20)
+    "T201",  # PrintUsed
+
+    # flake8-todos (TD)
+    "TD001",  # Invalid TODO tag
+    "TD003",  # Missing issue link on the line following this TODO
+    "TD004",  # Missing colon in TODO
+    "TD007",  # Missing space after colon in TODO
+
+    # tryceratops (TRY)
+    "TRY002",  # raise-vanilla-class
+    "TRY003",  # raise-vanilla-args
+    "TRY004",  # prefer-type-error
+    "TRY201",  # verbose-raise
+    "TRY301",  # raise-within-try
+
+    # flake8-quotes (Q)
+    "Q000",  # use double quotes
+]
+lint.unfixable = [
+    "E711"  # NoneComparison. Hard to fix b/c numpy has it's own None.
+]

{drizzle-1.15.3 → drizzle-2.0.0}/CHANGES.rst

@@ -4,6 +4,22 @@
 Release Notes
 =============
 
+2.0.0 (2024-10-23)
+==================
+
+- Backward incompatible major re-design of API. Backward compatibility was
+  maintained with JWST and Roman pipelines only. [#134]
+
+- Deprecated module ``util``. New software should not import from this
+  module as it will be removed in a future release. [#134]
+
+- Bug fix: exposure time was undefined when in_units were not cps. [#134]
+
+- BUG FIX: ``cdrizzle.tdriz`` signature was out of date. [#134]
+
+- Removed support for the ``'tophat'`` kernel. [#134]
+
+
 1.15.3 (2024-08-19)
 ===================
 

{drizzle-1.15.3 → drizzle-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: drizzle
-Version: 1.15.3
+Version: 2.0.0
 Summary: A package for combining dithered images into a single image
 Author-email: STScI <help@stsci.edu>
 License: Copyright (C) 2011,2014 Association of Universities for Research in
@@ -39,25 +39,28 @@ Project-URL: Homepage, https://github.com/spacetelescope/drizzle
 Project-URL: Bug Tracker, https://github.com/spacetelescope/drizzle/issues
 Project-URL: Documentation, http://spacetelescope.github.io/drizzle/
 Project-URL: Source Code, https://github.com/spacetelescope/drizzle
-Requires-Python: <3.13,>=3.10
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE.rst
 Requires-Dist: numpy
 Requires-Dist: astropy
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-doctestplus; extra == "test"
 Provides-Extra: docs
 Requires-Dist: tomli; python_version < "3.11" and extra == "docs"
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: sphinx-automodapi; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Requires-Dist: matplotlib; extra == "docs"
+Requires-Dist: pytest-doctestplus; extra == "docs"
 
 drizzle Documentation
 =====================
 
-.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
-    :target: http://www.astropy.org
+.. image:: https://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
+    :target: https://www.astropy.org
     :alt: Powered by Astropy Badge
 
 .. image:: https://codecov.io/github/spacetelescope/drizzle/branch/main/graphs/badge.svg
@@ -76,6 +79,10 @@ drizzle Documentation
     :target: https://pypi.org/project/drizzle
     :alt: PyPI Status
 
+.. image:: https://zenodo.org/badge/28100377.svg
+    :target: https://doi.org/10.5281/zenodo.10672889
+    :alt: Zenodo DOI
+
 The ``drizzle`` library is a Python package for combining dithered images into a
 single image. This library is derived from code used in DrizzlePac. Like
 DrizzlePac, most of the code is implemented in the C language. The biggest
@@ -188,177 +195,8 @@ missing information.
 The blot methods perform the inverse operation of drizzle. That is, blotting
 performs the inverse mapping to transform the dithered median image back into
 the coordinate system of the original input image. Blotting is primarily used
-for identifying cosmic rays in the original image. Like the original drizzle
-task, blot requires the user to provide the world coordinate system (WCS)
-transformations as inputs.
+for identifying cosmic rays in the original image. Blot requires the user
+to provide the world coordinate system (WCS)-based transformations in the
+form of a pixel map array as input.
 
 .. [Driz2012] Gonzaga, S., Hack, W., Fruchter, A., Mack, J., eds. 2012, The DrizzlePac Handbook. (Baltimore, STScI)
-
-
-The Drizzle Library
--------------------
-
-The Drizzle library is object-oriented and you use it by first creating an object of
-the ``Drizzle`` class. To create a new Drizzle output image, supply an Astropy
-WCS object representing the coordinate system of the output image.
-The other parameters are the linear pixel dimension described in the previous
-section, the drizzle kernel used, how each input image is scaled (by exposure
-time or time squared), and the pixel value set in the output image where the
-input images do not overlap.
-
-After creating a Drizzle object, you add one or more images by calling the
-``add_fits_file`` method. The arguments are the name of the FITS file containing
-the input image and optionally the name of a FITS file containing the pixel
-weighting. Both file names can be followed by an extension name or number in
-square brackets. Optionally you can pass the name of the header keywords
-containing the exposure time and units. Two units are understood: counts and
-cps (counts per second).
-
-The following function is a demonstration of how you can create a new output
-image::
-
-    def drizzle_demo_one(reference, outfile, infiles):
-        """
-        First demonstration of drizzle
-
-        Parameters
-        ==========
-        reference
-            A file containing the wcs of the output image
-
-        outfile
-            The name of the output image
-
-        infiles
-            The names of the input images to be combined
-        """
-        # Get the WCS for the output image
-        hdulist = fits.open(reference)
-        reference_wcs = wcs.WCS(hdulist[1].header)
-
-        # Initialize the output with the WCS
-        driz = drizzle.drizzle.Drizzle(outwcs=reference_wcs)
-
-        # Combine the input images into on drizzle image
-        for infile in infiles:
-            driz.add_fits_file(infile)
-
-        # Write the drizzled image out
-        driz.write(outfile)
-
-Optionally you can supply the input and weight images as Numpy arrays by using
-the ``add_image`` method. If you use this method, you must supply the extra
-information that would otherwise be read from the FITS image: The WCS
-of the input image, the exposure time, and image units.
-
-Here is an example of how you would call ``add_image``::
-
-    def drizzle_demo_two(reference, outfile, infiles):
-        """
-        Demonstration of drizzle with add image.
-
-        Parameters
-        ==========
-        reference
-            A file containing the wcs of the output image.
-
-        outfile
-            The name of the output image.
-
-        infiles
-            The names of the input images to be combined.
-        """
-        # Get the WCS for the output image
-        reflist = fits.open(reference)
-        reference_wcs = wcs.WCS(reflist[1].header)
-
-        # Initialize the output with the WCS
-        driz = drizzle.drizzle.Drizzle(outwcs=reference_wcs)
-
-        # Combine the input images into on drizzle image
-        for infile in infiles:
-            # Open the file and read the image and wcs
-            # This is a contrived example, we would not do this
-            # unless the data came from another source
-            # than a FITS file
-            imlist = fits.open(reference)
-            image = imlist[1].data
-            image_wcs = wcs.WCS(imlist[1].header)
-            driz.add_image(image, image_wcs)
-
-        # Write the drizzled image out
-        driz.write(outfile)
-
-After combining all the input images, you write the output image into a FITS
-file with the ``write`` method. You must pass the name of the output image and
-optionally the units. You can also supply a set of header cards to be added
-to the primary header of the output FITS file.
-
-You can also add more images to an existing Drizzle output file by creating
-a new Drizzle object and passing the existing output file name as the new
-object is created. In that case the output WCS and all
-other parameters are read from the file.
-
-Here is a demonstration of adding additional input images to a drizzled image::
-
-    def drizzle_demo_three(outfile, infiles):
-        """
-        Demonstration of drizzle and adding to an existing output.
-
-        Parameters
-        ==========
-        outfile
-            Name of output image that new files will be appended to.
-
-        infiles
-            The names of the input images to be added.
-        """
-        # Re-open the output file
-        driz = drizzle.drizzle.Drizzle(infile=outfile)
-
-        # Add the input images to the existing output image
-        for infile in infiles:
-            driz.add_fits_file(infile)
-
-        # Write the modified drizzled image out
-        driz.write(outfile)
-
-You can use the methods ``blot_fits_file`` and ``blot_image`` to transform the drizzled
-output image into another WCS. Most usually this is the
-coordinates of one of the input images and is used to identify cosmic rays or
-other defects. The two methods ``blot_fits_file`` and ``blot_image`` allow you to
-retrieve the WCS from the FITS file header or input it directly.
-The optional parameter ``interp`` allows you to selct the method used to resample
-the pixels on the new grid, and ``sincscl`` is used to scale the sinc function if one
-of the sinc interpolation methods is used. This function demonstrates how both
-methods are called::
-
-    def drizzle_demo_four(outfile, blotfile):
-        """
-        Demonstration of blot methods.
-
-        Parameters
-        ==========
-        outfile
-            Name of output image that will be converted.
-
-        blotfile
-            Name of image containing wcs to be transformed to.
-        """
-        # Open drizzle using the output file
-        # Transform it to another coordinate system
-        driz = drizzle.drizzle.Drizzle(infile=outfile)
-        driz.blot_fits_file(blotfile)
-        driz.write(outfile)
-
-        # Read the WCS and transform using it instead
-        # This is a contrived example
-        blotlist = fits.open(blotfile)
-        blot_wcs = wcs.WCS(blotlist[1].header)
-        driz = drizzle.drizzle.Drizzle(infile=outfile)
-        driz.blot_image(blot_wcs)
-        driz.write(outfile)
-
-The lower level function ``dodrizzle`` is present for backwards compatibility with
-the existing STScI DrizzlePac code and should not be used unless you are also
-concerned with this compatibility.