lsst.pipe.tasks  21.0.0-100-g362f0c00+4647f1f7f0
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.functors.ComputePixelScale Class Reference
Inheritance diagram for lsst.pipe.tasks.functors.ComputePixelScale:
lsst.pipe.tasks.functors.LocalWcs lsst.pipe.tasks.functors.Functor lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq lsst.pipe.tasks.functors.ConvertPixelToArcseconds

Public Member Functions

def columns (self)
 
def pixelScaleArcseconds (self, cd11, cd12, cd21, cd22)
 
def name (self)
 
def computeDeltaRaDec (self, x, y, cd11, cd12, cd21, cd22)
 
def computeSkySeperation (self, ra1, dec1, ra2, dec2)
 
def getSkySeperationFromPixel (self, x1, y1, x2, y2, cd11, cd12, cd21, cd22)
 
def noDup (self)
 
def multilevelColumns (self, data, columnIndex=None, returnTuple=False)
 
def __call__ (self, data, dropna=False)
 
def difference (self, data1, data2, **kwargs)
 
def fail (self, df)
 
def shortname (self)
 

Public Attributes

 colCD_1_1
 
 colCD_1_2
 
 colCD_2_1
 
 colCD_2_2
 
 filt
 
 dataset
 

Static Public Attributes

string name = "PixelScale"
 

Detailed Description

Compute the local pixel scale from the stored CDMatrix.

Definition at line 1199 of file functors.py.

Member Function Documentation

◆ __call__()

def lsst.pipe.tasks.functors.Functor.__call__ (   self,
  data,
  dropna = False 
)
inherited

Definition at line 322 of file functors.py.

◆ columns()

def lsst.pipe.tasks.functors.ComputePixelScale.columns (   self)
Columns required to perform calculation

Reimplemented from lsst.pipe.tasks.functors.Functor.

Reimplemented in lsst.pipe.tasks.functors.ConvertPixelSqToArcsecondsSq, and lsst.pipe.tasks.functors.ConvertPixelToArcseconds.

Definition at line 1205 of file functors.py.

◆ computeDeltaRaDec()

def lsst.pipe.tasks.functors.LocalWcs.computeDeltaRaDec (   self,
  x,
  y,
  cd11,
  cd12,
  cd21,
  cd22 
)
inherited
Compute the distance on the sphere from x2, y1 to x1, y1.

Parameters
----------
x : `pandas.Series`
    X pixel coordinate.
y : `pandas.Series`
    Y pixel coordinate.
cd11 : `pandas.Series`
    [1, 1] element of the local Wcs affine transform.
cd11 : `pandas.Series`
    [1, 1] element of the local Wcs affine transform.
cd12 : `pandas.Series`
    [1, 2] element of the local Wcs affine transform.
cd21 : `pandas.Series`
    [2, 1] element of the local Wcs affine transform.
cd22 : `pandas.Series`
    [2, 2] element of the local Wcs affine transform.

Returns
-------
raDecTuple : tuple
    RA and dec conversion of x and y given the local Wcs. Returned
    units are in radians.

Definition at line 1109 of file functors.py.

◆ computeSkySeperation()

def lsst.pipe.tasks.functors.LocalWcs.computeSkySeperation (   self,
  ra1,
  dec1,
  ra2,
  dec2 
)
inherited
Compute the local pixel scale conversion.

Parameters
----------
ra1 : `pandas.Series`
    Ra of the first coordinate in radians.
dec1 : `pandas.Series`
    Dec of the first coordinate in radians.
ra2 : `pandas.Series`
    Ra of the second coordinate in radians.
dec2 : `pandas.Series`
    Dec of the second coordinate in radians.

Returns
-------
dist : `pandas.Series`
    Distance on the sphere in radians.

Definition at line 1138 of file functors.py.

◆ difference()

def lsst.pipe.tasks.functors.Functor.difference (   self,
  data1,
  data2,
**  kwargs 
)
inherited
Computes difference between functor called on two different ParquetTable objects

Definition at line 333 of file functors.py.

◆ fail()

def lsst.pipe.tasks.functors.Functor.fail (   self,
  df 
)
inherited

Definition at line 338 of file functors.py.

◆ getSkySeperationFromPixel()

def lsst.pipe.tasks.functors.LocalWcs.getSkySeperationFromPixel (   self,
  x1,
  y1,
  x2,
  y2,
  cd11,
  cd12,
  cd21,
  cd22 
)
inherited
Compute the distance on the sphere from x2, y1 to x1, y1.

Parameters
----------
x1 : `pandas.Series`
    X pixel coordinate.
y1 : `pandas.Series`
    Y pixel coordinate.
x2 : `pandas.Series`
    X pixel coordinate.
y2 : `pandas.Series`
    Y pixel coordinate.
cd11 : `pandas.Series`
    [1, 1] element of the local Wcs affine transform.
cd11 : `pandas.Series`
    [1, 1] element of the local Wcs affine transform.
cd12 : `pandas.Series`
    [1, 2] element of the local Wcs affine transform.
cd21 : `pandas.Series`
    [2, 1] element of the local Wcs affine transform.
cd22 : `pandas.Series`
    [2, 2] element of the local Wcs affine transform.

Returns
-------
Distance : `pandas.Series`
    Arcseconds per pixel at the location of the local WC

Definition at line 1164 of file functors.py.

◆ multilevelColumns()

def lsst.pipe.tasks.functors.Functor.multilevelColumns (   self,
  data,
  columnIndex = None,
  returnTuple = False 
)
inherited
Returns columns needed by functor from multilevel dataset

To access tables with multilevel column structure, the `MultilevelParquetTable`
or `DeferredDatasetHandle` need to be passed either a list of tuples or a
dictionary.

Parameters
----------
data : `MultilevelParquetTable` or `DeferredDatasetHandle`

columnIndex (optional): pandas `Index` object
    either passed or read in from `DeferredDatasetHandle`.

`returnTuple` : bool
    If true, then return a list of tuples rather than the column dictionary
    specification.  This is set to `True` by `CompositeFunctor` in order to be able to
    combine columns from the various component functors.

Definition at line 205 of file functors.py.

◆ name()

def lsst.pipe.tasks.functors.Functor.name (   self)
inherited

◆ noDup()

def lsst.pipe.tasks.functors.Functor.noDup (   self)
inherited

Definition at line 124 of file functors.py.

◆ pixelScaleArcseconds()

def lsst.pipe.tasks.functors.ComputePixelScale.pixelScaleArcseconds (   self,
  cd11,
  cd12,
  cd21,
  cd22 
)
Compute the local pixel to scale conversion in arcseconds.

Parameters
----------
cd11 : `pandas.Series`
    [1, 1] element of the local Wcs affine transform in radians.
cd11 : `pandas.Series`
    [1, 1] element of the local Wcs affine transform in radians.
cd12 : `pandas.Series`
    [1, 2] element of the local Wcs affine transform in radians.
cd21 : `pandas.Series`
    [2, 1] element of the local Wcs affine transform in radians.
cd22 : `pandas.Series`
    [2, 2] element of the local Wcs affine transform in radians.

Returns
-------
pixScale : `pandas.Series`
    Arcseconds per pixel at the location of the local WC

Definition at line 1211 of file functors.py.

◆ shortname()

def lsst.pipe.tasks.functors.Functor.shortname (   self)
inherited
Short name of functor (suitable for column name/dict key)

Reimplemented in lsst.pipe.tasks.functors.Color, and lsst.pipe.tasks.functors.MagDiff.

Definition at line 348 of file functors.py.

Member Data Documentation

◆ colCD_1_1

lsst.pipe.tasks.functors.LocalWcs.colCD_1_1
inherited

Definition at line 1103 of file functors.py.

◆ colCD_1_2

lsst.pipe.tasks.functors.LocalWcs.colCD_1_2
inherited

Definition at line 1104 of file functors.py.

◆ colCD_2_1

lsst.pipe.tasks.functors.LocalWcs.colCD_2_1
inherited

Definition at line 1105 of file functors.py.

◆ colCD_2_2

lsst.pipe.tasks.functors.LocalWcs.colCD_2_2
inherited

Definition at line 1106 of file functors.py.

◆ dataset

lsst.pipe.tasks.functors.Functor.dataset
inherited

Definition at line 120 of file functors.py.

◆ filt

lsst.pipe.tasks.functors.Functor.filt
inherited

Definition at line 119 of file functors.py.

◆ name

string lsst.pipe.tasks.functors.ComputePixelScale.name = "PixelScale"
static

Definition at line 1202 of file functors.py.


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