lsst::jointcal::CcdImage Class Reference

Handler of an actual image from a single CCD. More...

#include <CcdImage.h>

Public Member Functions
	CcdImage (afw::table::SourceCatalog &record, std::shared_ptr< lsst::afw::geom::SkyWcs > wcs, std::shared_ptr< lsst::afw::image::VisitInfo > visitInfo, lsst::geom::Box2I const &bbox, std::string const &filter, std::shared_ptr< afw::image::PhotoCalib > photoCalib, std::shared_ptr< afw::cameraGeom::Detector > detector, int visit, int ccd, std::string const &fluxField)
	CcdImage (CcdImage const &)=delete
	No move or copy: each CCD image is unique to that ccd+visit, and Associations holds all CcdImages. More...
	CcdImage (CcdImage &&)=delete
CcdImage &	operator= (CcdImage const &)=delete
CcdImage &	operator= (CcdImage &&)=delete
std::string	getName () const
	Return the _name that identifies this ccdImage. More...
MeasuredStarList const &	getWholeCatalog () const
	Gets the as-read catalog. More...
MeasuredStarList const &	getCatalogForFit () const
	Gets the catalog to be used for fitting, which may have been cleaned-up. More...
MeasuredStarList &	getCatalogForFit ()
void	resetCatalogForFit ()
	Clear the catalog for fitting and set it to a copy of the whole catalog. More...
std::pair< int, int >	countStars () const
	Count the number of valid measured and reference stars that fall within this ccdImage. More...
void	setCommonTangentPoint (Point const &commonTangentPoint)
	Sets the common tangent point and computes necessary transforms. More...
jointcal::Point const &	getCommonTangentPoint () const
	Gets the common tangent point, shared between all ccdImages. More...
std::shared_ptr< AstrometryTransform > const	getPixelToCommonTangentPlane () const
std::shared_ptr< AstrometryTransform > const	getCommonTangentPlaneToTangentPlane () const
std::shared_ptr< AstrometryTransform > const	getTangentPlaneToCommonTangentPlane () const
std::shared_ptr< AstrometryTransform > const	getPixelToTangentPlane () const
std::shared_ptr< AstrometryTransform > const	getSkyToTangentPlane () const
CcdIdType	getCcdId () const
	returns ccd ID More...
VisitIdType	getVisit () const
	returns visit ID More...
std::shared_ptr< afw::cameraGeom::Detector >	getDetector () const
CcdImageKey	getHashKey () const
double	getAirMass () const
	Airmass. More...
double	getEpoch () const
std::shared_ptr< afw::image::PhotoCalib >	getPhotoCalib () const
	Return the exposure's photometric calibration. More...
lsst::geom::SpherePoint	getBoresightRaDec () const
	Gets the boresight RA/Dec. More...
double	getHourAngle () const
double	getLstObs () const
double	getSinEta () const
	Parallactic angle. More...
double	getCosEta () const
	Parallactic angle. More...
double	getTanZ () const
	Parallactic angle. More...
Point	getRefractionVector () const
std::string	getFilter () const
	return the CcdImage filter name More...
std::shared_ptr< AstrometryTransform > const	getReadWcs () const
	the wcs read in the header. NOT updated when fitting. More...
Frame const &	getImageFrame () const
	Frame in pixels. More...

Detailed Description

Handler of an actual image from a single CCD.

NOTE: could possibly be replaced with a subclass of afw.image.Exposure?

Definition at line 64 of file CcdImage.h.

Constructor & Destructor Documentation

CcdImage() [1/3]

lsst::jointcal::CcdImage::CcdImage	(	afw::table::SourceCatalog &	record,
		std::shared_ptr< lsst::afw::geom::SkyWcs >	wcs,
		std::shared_ptr< lsst::afw::image::VisitInfo >	visitInfo,
		lsst::geom::Box2I const &	bbox,
		std::string const &	filter,
		std::shared_ptr< afw::image::PhotoCalib >	photoCalib,
		std::shared_ptr< afw::cameraGeom::Detector >	detector,
		int	visit,
		int	ccd,
		std::string const &	fluxField
	)

Definition at line 111 of file CcdImage.cc.

        : _ccdId(ccdId), _visit(visit), _photoCalib(photoCalib), _detector(detector), _filter(filter) {
    loadCatalog(catalog, fluxField);
 
    Point lowerLeft(bbox.getMinX(), bbox.getMinY());
    Point upperRight(bbox.getMaxX(), bbox.getMaxY());
    _imageFrame = Frame(lowerLeft, upperRight);
 
    _readWcs = std::make_shared<AstrometryTransformSkyWcs>(wcs);
 
    std::stringstream out;
    out << visit << "_" << ccdId;
    _name = out.str();
 
    _boresightRaDec = visitInfo->getBoresightRaDec();
    _airMass = visitInfo->getBoresightAirmass();
    _epoch = visitInfo->getDate().get(lsst::daf::base::DateTime::EPOCH);
    _lstObs = visitInfo->getEra();
    _hourAngle = visitInfo->getBoresightHourAngle();
 
    // Some cameras don't manage ERA (and thus Hour Angle) properly, so it's going to be NaN.
    // Because we need the refraction vector later, go with 0 HA to prevent crashes on that NaN.
    if (std::isnan(_hourAngle) == true) {
        _hourAngle = 0;
    }
 
    if (_airMass == 1)
        _sinEta = _cosEta = _tanZ = 0;
    else {
        double cosz = 1. / _airMass;
        double sinz = std::sqrt(1 - cosz * cosz);  // astronomers usually observe above the horizon
        _tanZ = sinz / cosz;
        lsst::geom::Angle eta = visitInfo->getBoresightParAngle();
        _sinEta = std::sin(eta.asRadians());
        _cosEta = std::cos(eta.asRadians());
    }
}

CcdImage() [2/3]

lsst::jointcal::CcdImage::CcdImage ( CcdImage const &  )

delete

No move or copy: each CCD image is unique to that ccd+visit, and Associations holds all CcdImages.

CcdImage() [3/3]

lsst::jointcal::CcdImage::CcdImage ( CcdImage &&  )

delete

Member Function Documentation

countStars()

std::pair< int, int > lsst::jointcal::CcdImage::countStars

(

)

const

Count the number of valid measured and reference stars that fall within this ccdImage.

Measured stars are counted if they are valid. Reference stars are counted if a measured star (valid or not) has a fittedStar that has an associated refStar.

Returns

Number of (measured, reference) stars in the image.

Definition at line 153 of file CcdImage.cc.

                                             {
    int measuredStars = 0;
    int refStars = 0;
    for (auto const &measuredStar : _catalogForFit) {
        if (measuredStar->isValid()) {
            measuredStars++;
        }
        if ((measuredStar->getFittedStar() != nullptr) &&
            (measuredStar->getFittedStar()->getRefStar() != nullptr)) {
            refStars++;
        }
    }
    return std::make_pair(measuredStars, refStars);
}

getAirMass()

double lsst::jointcal::CcdImage::getAirMass ( ) const

inline

Airmass.

Definition at line 155 of file CcdImage.h.

{ return _airMass; }

getBoresightRaDec()

lsst::geom::SpherePoint lsst::jointcal::CcdImage::getBoresightRaDec ( ) const

inline

Gets the boresight RA/Dec.

Definition at line 165 of file CcdImage.h.

{ return _boresightRaDec; }

getCatalogForFit() [1/2]

MeasuredStarList& lsst::jointcal::CcdImage::getCatalogForFit ( )

inline

Definition at line 95 of file CcdImage.h.

{ return _catalogForFit; }

getCatalogForFit() [2/2]

MeasuredStarList const& lsst::jointcal::CcdImage::getCatalogForFit ( ) const

inline

Gets the catalog to be used for fitting, which may have been cleaned-up.

Returns

The catalog for fitting.

Definition at line 94 of file CcdImage.h.

{ return _catalogForFit; }

getCcdId()

CcdIdType lsst::jointcal::CcdImage::getCcdId ( ) const

inline

returns ccd ID

Definition at line 145 of file CcdImage.h.

{ return _ccdId; }

getCommonTangentPlaneToTangentPlane()

std::shared_ptr<AstrometryTransform> const lsst::jointcal::CcdImage::getCommonTangentPlaneToTangentPlane ( ) const

inline

Definition at line 132 of file CcdImage.h.

                                                                                         {
        return _commonTangentPlaneToTangentPlane;
    }

getCommonTangentPoint()

jointcal::Point const& lsst::jointcal::CcdImage::getCommonTangentPoint ( ) const

inline

Gets the common tangent point, shared between all ccdImages.

Returns

The common tangent point of all ccdImages (decimal degrees).

Definition at line 126 of file CcdImage.h.

{ return _commonTangentPoint; }

getCosEta()

double lsst::jointcal::CcdImage::getCosEta ( ) const

inline

Parallactic angle.

Definition at line 175 of file CcdImage.h.

{ return _cosEta; }

getDetector()

std::shared_ptr<afw::cameraGeom::Detector> lsst::jointcal::CcdImage::getDetector ( ) const

inline

Definition at line 150 of file CcdImage.h.

{ return _detector; }

getEpoch()

double lsst::jointcal::CcdImage::getEpoch ( ) const

inline

Definition at line 157 of file CcdImage.h.

{ return _epoch; }

getFilter()

std::string lsst::jointcal::CcdImage::getFilter ( ) const

inline

return the CcdImage filter name

Definition at line 184 of file CcdImage.h.

{ return _filter; }

getHashKey()

CcdImageKey lsst::jointcal::CcdImage::getHashKey ( ) const

inline

Definition at line 152 of file CcdImage.h.

{ return CcdImageKey{_visit, _ccdId}; }

getHourAngle()

double lsst::jointcal::CcdImage::getHourAngle ( ) const

inline

Definition at line 167 of file CcdImage.h.

{ return _hourAngle; }

getImageFrame()

Frame const& lsst::jointcal::CcdImage::getImageFrame ( ) const

inline

Frame in pixels.

Definition at line 190 of file CcdImage.h.

{ return _imageFrame; }

getLstObs()

double lsst::jointcal::CcdImage::getLstObs ( ) const

inline

Definition at line 169 of file CcdImage.h.

{ return _lstObs; }

getName()

std::string lsst::jointcal::CcdImage::getName ( ) const

inline

Return the _name that identifies this ccdImage.

Definition at line 79 of file CcdImage.h.

{ return _name; }

getPhotoCalib()

std::shared_ptr<afw::image::PhotoCalib> lsst::jointcal::CcdImage::getPhotoCalib ( ) const

inline

Return the exposure's photometric calibration.

Definition at line 160 of file CcdImage.h.

{ return _photoCalib; }

getPixelToCommonTangentPlane()

std::shared_ptr<AstrometryTransform> const lsst::jointcal::CcdImage::getPixelToCommonTangentPlane ( ) const

inline

Definition at line 128 of file CcdImage.h.

                                                                                  {
        return _pixelToCommonTangentPlane;
    }

getPixelToTangentPlane()

std::shared_ptr<AstrometryTransform> const lsst::jointcal::CcdImage::getPixelToTangentPlane ( ) const

inline

Definition at line 140 of file CcdImage.h.

{ return _pixelToTangentPlane; }

getReadWcs()

std::shared_ptr<AstrometryTransform> const lsst::jointcal::CcdImage::getReadWcs ( ) const

inline

the wcs read in the header. NOT updated when fitting.

Definition at line 187 of file CcdImage.h.

{ return _readWcs; }

getRefractionVector()

Point lsst::jointcal::CcdImage::getRefractionVector ( ) const

inline

Definition at line 181 of file CcdImage.h.

{ return Point(_tanZ * _cosEta, _tanZ * _sinEta); }

getSinEta()

double lsst::jointcal::CcdImage::getSinEta ( ) const

inline

Parallactic angle.

Definition at line 172 of file CcdImage.h.

{ return _sinEta; }

getSkyToTangentPlane()

std::shared_ptr<AstrometryTransform> const lsst::jointcal::CcdImage::getSkyToTangentPlane ( ) const

inline

Definition at line 142 of file CcdImage.h.

{ return _skyToTangentPlane; }

getTangentPlaneToCommonTangentPlane()

std::shared_ptr<AstrometryTransform> const lsst::jointcal::CcdImage::getTangentPlaneToCommonTangentPlane ( ) const

inline

Definition at line 136 of file CcdImage.h.

                                                                                         {
        return _tangentPlaneToCommonTangentPlane;
    }

getTanZ()

double lsst::jointcal::CcdImage::getTanZ ( ) const

inline

Parallactic angle.

Definition at line 178 of file CcdImage.h.

{ return _tanZ; }

getVisit()

VisitIdType lsst::jointcal::CcdImage::getVisit ( ) const

inline

returns visit ID

Definition at line 148 of file CcdImage.h.

{ return _visit; }

getWholeCatalog()

MeasuredStarList const& lsst::jointcal::CcdImage::getWholeCatalog ( ) const

inline

Gets the as-read catalog.

Returns

The whole catalog.

Definition at line 86 of file CcdImage.h.

{ return _wholeCatalog; }

operator=() [1/2]

CcdImage& lsst::jointcal::CcdImage::operator= ( CcdImage &&  )

delete

operator=() [2/2]

CcdImage& lsst::jointcal::CcdImage::operator= ( CcdImage const &  )

delete

resetCatalogForFit()

void lsst::jointcal::CcdImage::resetCatalogForFit ( )

inline

Clear the catalog for fitting and set it to a copy of the whole catalog.

Definition at line 99 of file CcdImage.h.

                              {
        getCatalogForFit().clear();
        getWholeCatalog().copyTo(getCatalogForFit());
    }

setCommonTangentPoint()

void lsst::jointcal::CcdImage::setCommonTangentPoint

(

Point const &

commonTangentPoint

)

Sets the common tangent point and computes necessary transforms.

Parameters

[in]

commonTangentPoint

The common tangent point of all ccdImages (decimal degrees).

Definition at line 168 of file CcdImage.cc.

                                                                    {
    _commonTangentPoint = commonTangentPoint;
 
    auto const crval = _readWcs->getSkyWcs()->getSkyOrigin();
    jointcal::Point tangentPoint(crval[0].asDegrees(), crval[1].asDegrees());
 
    /* we don't assume here that we know the internals of TanPixelToRaDec:
       to construct pix->TP, we do pix->sky->TP, although pix->sky
       actually goes through TP */
    AstrometryTransformLinear identity;
    TanRaDecToPixel raDecToTangentPlane(identity, tangentPoint);
    _pixelToTangentPlane = compose(raDecToTangentPlane, *_readWcs);
    TanPixelToRaDec CommonTangentPlane2RaDec(identity, commonTangentPoint);
    _commonTangentPlaneToTangentPlane = compose(raDecToTangentPlane, CommonTangentPlane2RaDec);
 
    // jump from one TP to an other:
    TanRaDecToPixel raDecToCommonTangentPlane(identity, commonTangentPoint);
    TanPixelToRaDec TangentPlaneToRaDec(identity, tangentPoint);
    _tangentPlaneToCommonTangentPlane = compose(raDecToCommonTangentPlane, TangentPlaneToRaDec);
    _skyToTangentPlane.reset(new TanRaDecToPixel(identity, tangentPoint));
 
    // this one is needed for matches :
    _pixelToCommonTangentPlane = compose(raDecToCommonTangentPlane, *_readWcs);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/include/lsst/jointcal/CcdImage.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/jointcal/22.0.1-25-g5bf6245+3ad8ecd50b/src/CcdImage.cc