lsst.scarlet.lite.models.parametric.CartesianFrame Class Reference

Inheritance diagram for lsst.scarlet.lite.models.parametric.CartesianFrame:

Public Member Functions
	__init__ (self, Box bbox)
tuple[int,...]	shape (self)
Box	bbox (self)
np.ndarray	x_grid (self)
np.ndarray	y_grid (self)

Protected Attributes
	_bbox
	_x
	_y
	_r
	_r2

Detailed Description

A grid of X and Y values contained in a bbox

Definition at line 60 of file parametric.py.

Constructor & Destructor Documentation

__init__()

lsst.scarlet.lite.models.parametric.CartesianFrame.__init__	(		self,
		Box	bbox )

Parameters
----------
bbox: Box
    The bounding box that contains this frame.

Reimplemented in lsst.scarlet.lite.models.parametric.EllipseFrame.

Definition at line 63 of file parametric.py.

    def __init__(self, bbox: Box):
        """
        Parameters
        ----------
        bbox: Box
            The bounding box that contains this frame.
        """
        # Store the new bounding box
        self._bbox = bbox
        # Get the range of x and y
        yi, xi = bbox.start[-2:]
        yf, xf = bbox.stop[-2:]
        height, width = bbox.shape[-2:]
        y = np.linspace(yi, yf - 1, height)
        x = np.linspace(xi, xf - 1, width)
        # Create the grid used to create the image of the frame
        self._x, self._y = np.meshgrid(x, y)
        self._r = None
        self._r2 = None
 

Member Function Documentation

bbox()

Box lsst.scarlet.lite.models.parametric.CartesianFrame.bbox

(

self

)

Bounding box containing the frame

Reimplemented in lsst.scarlet.lite.models.parametric.EllipseFrame.

Definition at line 89 of file parametric.py.

    def bbox(self) -> Box:
        """Bounding box containing the frame"""
        return self._bbox
 

shape()

tuple[int, ...] lsst.scarlet.lite.models.parametric.CartesianFrame.shape

(

self

)

Shape of the frame.

Definition at line 84 of file parametric.py.

    def shape(self) -> tuple[int, ...]:
        """Shape of the frame."""
        return self._bbox.shape
 

x_grid()

np.ndarray lsst.scarlet.lite.models.parametric.CartesianFrame.x_grid

(

self

)

The grid of x-values for the entire frame

Definition at line 94 of file parametric.py.

    def x_grid(self) -> np.ndarray:
        """The grid of x-values for the entire frame"""
        return self._x
 

y_grid()

np.ndarray lsst.scarlet.lite.models.parametric.CartesianFrame.y_grid

(

self

)

The grid of y-values for the entire frame

Definition at line 99 of file parametric.py.

    def y_grid(self) -> np.ndarray:
        """The grid of y-values for the entire frame"""
        return self._y
 
 

Member Data Documentation

_bbox

lsst.scarlet.lite.models.parametric.CartesianFrame._bbox

protected

Definition at line 71 of file parametric.py.

_r

lsst.scarlet.lite.models.parametric.CartesianFrame._r

protected

Definition at line 80 of file parametric.py.

_r2

lsst.scarlet.lite.models.parametric.CartesianFrame._r2

protected

Definition at line 81 of file parametric.py.

_x

lsst.scarlet.lite.models.parametric.CartesianFrame._x

protected

Definition at line 79 of file parametric.py.

_y

lsst.scarlet.lite.models.parametric.CartesianFrame._y

protected

Definition at line 79 of file parametric.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/scarlet_lite/gae0086650b+585e252eca/python/lsst/scarlet/lite/models/parametric.py