lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > Class Template Reference

A set of pixels in an Image, including those pixels' actual values. More...

#include <HeavyFootprint.h>

Inheritance diagram for lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >:

Classes
class	Factory

Public Types
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback) (const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback) (const Citizen *ptr)

Public Member Functions
	HeavyFootprint (Footprint const &foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &mimage, HeavyFootprintCtrl const *ctrl=NULL)
	Create a HeavyFootprint from a regular Footprint and the image that provides the pixel values. More...
	HeavyFootprint (Footprint const &foot, HeavyFootprintCtrl const *ctrl=NULL)
	Create a HeavyFootprint from a regular Footprint, allocating space to hold foot.getArea() pixels, but not initializing them. More...
	HeavyFootprint ()=default
	Default constructor for HeavyFootprint. More...
	~HeavyFootprint () override=default
	HeavyFootprint (HeavyFootprint const &other)=default
	HeavyFootprint (HeavyFootprint &&other)=default
HeavyFootprint &	operator= (HeavyFootprint const &)=default
HeavyFootprint &	operator= (HeavyFootprint &&)=default
bool	isHeavy () const override
	Is this a HeavyFootprint (yes!) More...
void	insert (lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &mimage) const
	Replace all the pixels in the image with the values in the HeavyFootprint. More...
void	insert (lsst::afw::image::Image< ImagePixelT > &image) const
	Replace all the pixels in the image with the values in the HeavyFootprint. More...
ndarray::Array< ImagePixelT, 1, 1 >	getImageArray ()
ndarray::Array< MaskPixelT, 1, 1 >	getMaskArray ()
ndarray::Array< VariancePixelT, 1, 1 >	getVarianceArray ()
ndarray::Array< ImagePixelT const, 1, 1 >	getImageArray () const
ndarray::Array< MaskPixelT const, 1, 1 >	getMaskArray () const
ndarray::Array< VariancePixelT const, 1, 1 >	getVarianceArray () const
MaskPixelT	getMaskBitsSet () const
double	dot (HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &other) const
	Dot product between HeavyFootprints. More...
std::shared_ptr< geom::SpanSet >	getSpans () const
	Return a shared pointer to the SpanSet. More...
void	setSpans (std::shared_ptr< geom::SpanSet > otherSpanSet)
	Sets the shared pointer to the SpanSet in the Footprint. More...
PeakCatalog &	getPeaks ()
	Return the Peaks contained in this Footprint. More...
const PeakCatalog &	getPeaks () const
std::shared_ptr< PeakRecord >	addPeak (float fx, float fy, float value)
	Convenience function to add a peak. More...
void	sortPeaks (afw::table::Key< float > const &key=afw::table::Key< float >())
	Sort Peaks from most positive value to most negative. More...
void	setPeakSchema (afw::table::Schema const &peakSchema)
	Set the Schema used by the PeakCatalog (will throw if PeakCatalog is not empty). More...
void	setPeakCatalog (PeakCatalog const &otherPeaks)
	Set the peakCatalog to a copy of the supplied catalog. More...
std::size_t	getArea () const
	Return the number of pixels in this Footprint. More...
lsst::geom::Point2D	getCentroid () const
	Return the Footprint's centroid. More...
geom::ellipses::Quadrupole	getShape () const
	Return the Footprint's shape (interpreted as an ellipse) More...
void	shift (int dx, int dy)
	Shift a Footprint by (dx, dy) More...
void	shift (lsst::geom::ExtentI const &d)
	Shift a Footprint by a given extent. More...
lsst::geom::Box2I	getBBox () const
	Return the Footprint's bounding box. More...
lsst::geom::Box2I	getRegion () const
	Return the corners of the MaskedImage the footprints live in. More...
void	setRegion (lsst::geom::Box2I const &region)
	Set the corners of the MaskedImage wherein the footprints dwell. More...
void	clipTo (lsst::geom::Box2I const &bbox)
	Clip the Footprint such that all values lie inside the supplied Bounding Box. More...
bool	contains (lsst::geom::Point2I const &pix) const
	Tests if a pixel postion falls inside the Footprint. More...
std::shared_ptr< Footprint >	transform (std::shared_ptr< geom::SkyWcs > source, std::shared_ptr< geom::SkyWcs > target, lsst::geom::Box2I const &region, bool doClip=true) const
	Transform the footprint from one WCS to another. More...
std::shared_ptr< Footprint >	transform (lsst::geom::LinearTransform const &t, lsst::geom::Box2I const &region, bool doClip=true) const
	Return a new Footprint whose pixels are the product of applying the specified transformation. More...
std::shared_ptr< Footprint >	transform (lsst::geom::AffineTransform const &t, lsst::geom::Box2I const &region, bool doClip=true) const
	Return a new Footprint whose pixels are the product of applying the specified transformation. More...
std::shared_ptr< Footprint >	transform (geom::TransformPoint2ToPoint2 const &t, lsst::geom::Box2I const &region, bool doClip=true) const
	Return a new Footprint whose pixels are the product of applying the specified transformation. More...
bool	isPersistable () const noexcept override
	Report if this object is persistable. More...
void	dilate (int r, geom::Stencil s=geom::Stencil::CIRCLE)
	Dilate the Footprint with a defined kernel. More...
void	dilate (geom::SpanSet const &other)
	Dilate the Footprint with a defined kernel. More...
void	erode (int r, geom::Stencil s=geom::Stencil::CIRCLE)
	Erode the Footprint with a defined kernel. More...
void	erode (geom::SpanSet const &other)
	Erode the Footprint with a defined kernel. More...
void	removeOrphanPeaks ()
	Remove peaks from the PeakCatalog that fall outside the area of the Footprint. More...
bool	isContiguous () const
	Reports if the Footprint is simply connected or has multiple components. More...
std::vector< std::shared_ptr< Footprint > >	split () const
	Split a multi-component Footprint into a vector of contiguous Footprints. More...
bool	operator== (Footprint const &other) const
	equality operator More...
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file. More...
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory. More...
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object. More...

Static Public Member Functions
static std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...
static std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...
static std::shared_ptr< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static std::shared_ptr< lsst::afw::detection::Footprint >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object. More...
static std::shared_ptr< lsst::afw::detection::Footprint >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file. More...
static std::shared_ptr< lsst::afw::detection::Footprint >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory. More...
static std::shared_ptr< lsst::afw::detection::Footprint >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr. More...
Census
Provide a list of current Citizens
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector< const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
callbackIDs
Set callback Ids. The old Id is returned
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Protected Types
typedef io::OutputArchiveHandle	OutputArchiveHandle

Protected Member Functions
std::string	getPersistenceName () const override
	Return the name correspoinging ot the persistence type. More...
void	write (OutputArchiveHandle &handle) const override
	Write an instance of a Footprint to an output Archive. More...
std::string	getPythonModule () const override
	Return the python module the object will live in. More...

Static Protected Member Functions
static std::unique_ptr< Footprint >	readSpanSet (afw::table::BaseCatalog const &, afw::table::io::InputArchive const &)
	Static method used to unpersist the SpanSet member of the Footprint class. More...
static void	readPeaks (afw::table::BaseCatalog const &, Footprint &)
	Static method used to unpersist the PeakCatalog member of the Footprint class. More...

Detailed Description

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>
class lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >

A set of pixels in an Image, including those pixels' actual values.

Definition at line 47 of file HeavyFootprint.h.

Member Typedef Documentation

memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 61 of file Citizen.h.

memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 58 of file Citizen.h.

memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 60 of file Citizen.h.

OutputArchiveHandle

typedef io::OutputArchiveHandle lsst::afw::table::io::Persistable::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 88 of file Citizen.h.

{ magicSentinel = 0xdeadbeef };  

Constructor & Destructor Documentation

HeavyFootprint() [1/5]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( Footprint const &  foot, lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > const &  mimage, HeavyFootprintCtrl const *  ctrl = NULL  )

explicit

Create a HeavyFootprint from a regular Footprint and the image that provides the pixel values.

Parameters

foot	The Footprint defining the pixels to set
mimage	The pixel values
ctrl	Control how we manipulate HeavyFootprints

Note

the HeavyFootprintCtrl is passed by const* not const& so that we needn't provide a definition in the header.

Definition at line 75 of file HeavyFootprint.cc.

        : Footprint(foot),
          _image(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
          _mask(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
          _variance(ndarray::allocate(ndarray::makeVector(foot.getArea()))) {
    HeavyFootprintCtrl ctrl_s = HeavyFootprintCtrl();

    if (!ctrl) {
        ctrl = &ctrl_s;
    }

    switch (ctrl->getModifySource()) {
        case HeavyFootprintCtrl::NONE:
            getSpans()->flatten(_image, mimage.getImage()->getArray(), mimage.getXY0());
            getSpans()->flatten(_mask, mimage.getMask()->getArray(), mimage.getXY0());
            getSpans()->flatten(_variance, mimage.getVariance()->getArray(), mimage.getXY0());
            break;
        case HeavyFootprintCtrl::SET: {
            ImagePixelT const ival = ctrl->getImageVal();
            MaskPixelT const mval = ctrl->getMaskVal();
            VariancePixelT const vval = ctrl->getVarianceVal();

            getSpans()->applyFunctor(FlattenWithSetter<ImagePixelT>(ival), ndarray::ndFlat(_image),
                                     ndarray::ndImage(mimage.getImage()->getArray(), mimage.getXY0()));
            getSpans()->applyFunctor(FlattenWithSetter<MaskPixelT>(mval), ndarray::ndFlat(_mask),
                                     ndarray::ndImage(mimage.getMask()->getArray(), mimage.getXY0()));
            getSpans()->applyFunctor(FlattenWithSetter<VariancePixelT>(vval), ndarray::ndFlat(_variance),
                                     ndarray::ndImage(mimage.getVariance()->getArray(), mimage.getXY0()));
            break;
        }
    }
}

HeavyFootprint() [2/5]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( Footprint const &  foot, HeavyFootprintCtrl const *  ctrl = NULL  )

explicit

Create a HeavyFootprint from a regular Footprint, allocating space to hold foot.getArea() pixels, but not initializing them.

This is used when unpersisting a HeavyFootprint.

Parameters

foot	The Footprint defining the pixels to set
ctrl	Control how we manipulate HeavyFootprints

Definition at line 111 of file HeavyFootprint.cc.

        : Footprint(foot),
          _image(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
          _mask(ndarray::allocate(ndarray::makeVector(foot.getArea()))),
          _variance(ndarray::allocate(ndarray::makeVector(foot.getArea()))) {}

HeavyFootprint() [3/5]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( )

default

Default constructor for HeavyFootprint.

Most common use for this will be in combination with the assignment operator

~HeavyFootprint()

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::~HeavyFootprint ( )

overridedefault

HeavyFootprint() [4/5]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &  other )

default

HeavyFootprint() [5/5]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::HeavyFootprint ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > &&  other )

default

Member Function Documentation

addPeak()

std::shared_ptr< PeakRecord > lsst::afw::detection::Footprint::addPeak ( float  fx, float  fy, float  value  )

inherited

Convenience function to add a peak.

Parameters

fx	Float containing the x position of a peak
fy	Float containing the y position of a peak
value	The intensity value of the peak

Definition at line 50 of file Footprint.cc.

                                                                             {
    std::shared_ptr<PeakRecord> p = getPeaks().addNew();
    p->setIx(fx);
    p->setIy(fy);
    p->setFx(fx);
    p->setFy(fy);
    p->setPeakValue(height);
    return p;
}

census() [1/3]

int lsst::daf::base::Citizen::census ( int  , memId  startingMemId = 0  )

staticinherited

How many active Citizens are there?

Parameters

startingMemId

Don't print Citizens with lower IDs

Definition at line 238 of file Citizen.cc.

  {
    if (startingMemId == 0) {  // easy
        ReadGuard guard(citizenLock);
        return _activeCitizens.size();
    }

    int n = 0;
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        if (cur->first->_CitizenId >= startingMemId) {
            n++;
        }
    }

    return n;
}

census() [2/3]

void lsst::daf::base::Citizen::census ( std::ostream &  stream, memId  startingMemId = 0  )

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 259 of file Citizen.cc.

  {
    ReadGuard guard(citizenLock);

    std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());

    for (std::vector<Citizen const*>::const_iterator citizen = leaks->begin(), end = leaks->end();
         citizen != end; ++citizen) {
        if ((*citizen)->getId() >= startingMemId) {
            stream << (*citizen)->repr() << "\n";
        }
    }
}

census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 287 of file Citizen.cc.

                                                               {
    std::vector<Citizen const*>* vec = new std::vector<Citizen const*>(0);
    ReadGuard guard(citizenLock);
    vec->reserve(_activeCitizens.size());

    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        vec->push_back(dynamic_cast<Citizen const*>(cur->first));
    }

    std::sort(vec->begin(), vec->end(), cmpId);

    return vec;
}

clipTo()

void lsst::afw::detection::Footprint::clipTo ( lsst::geom::Box2I const &  bbox )

inherited

Clip the Footprint such that all values lie inside the supplied Bounding Box.

Parameters

bbox	Integer box object that defines the boundaries the footprint should be clipped to.

Definition at line 77 of file Footprint.cc.

                                               {
    setSpans(getSpans()->clippedTo(box));
    removeOrphanPeaks();
}

contains()

bool lsst::afw::detection::Footprint::contains ( lsst::geom::Point2I const &  pix ) const

inherited

Tests if a pixel postion falls inside the Footprint.

Parameters

pix	Integer point object defining the position of a pixel to test

Definition at line 82 of file Footprint.cc.

{ return getSpans()->contains(pix); }

dilate() [1/2]

void lsst::afw::detection::Footprint::dilate ( int  r, geom::Stencil  s = geom::Stencil::CIRCLE  )

inherited

Dilate the Footprint with a defined kernel.

This function enlarges the SpanSet which defines the area of the Footprint by an amount governed by in input kernel

Parameters

r	The radius of the stencil object used to create a dilation kernel
s	The stencil object used to create the dilation kernel

Definition at line 125 of file Footprint.cc.

{ setSpans(getSpans()->dilated(r, s)); }

dilate() [2/2]

void lsst::afw::detection::Footprint::dilate ( geom::SpanSet const &  other )

inherited

Dilate the Footprint with a defined kernel.

This function enlarges the SpanSet which defines the area of the Footprint by an amount governed by the input kernel

Parameters

other

SpanSet to use as the kernel in dilation

Definition at line 127 of file Footprint.cc.

{ setSpans(getSpans()->dilated(other)); }

dot()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

double lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::dot

(

HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &

other

)

const

Dot product between HeavyFootprints.

The mask and variance planes are ignored.

Definition at line 155 of file HeavyFootprint.cc.

                                                                                  {
    // Coordinated cycling through the iterators while juggling the offsets into the arrays
    typedef typename ndarray::Array<ImagePixelT const, 1, 1>::Iterator ArrayIter;
    ArrayIter lhsArray = getImageArray().begin(), rhsArray = rhs.getImageArray().begin();
    auto lhsIter = getSpans()->begin(), rhsIter = rhs.getSpans()->begin();
    auto const lhsEnd = getSpans()->end(), rhsEnd = rhs.getSpans()->end();
    double sum = 0.0;
    while (lhsIter != lhsEnd && rhsIter != rhsEnd) {
        geom::Span const &lhsSpan = *lhsIter, rhsSpan = *rhsIter;
        int const yLhs = lhsSpan.getY(), yRhs = rhsSpan.getY();
        if (yLhs == yRhs) {
            int const x0Lhs = lhsSpan.getX0(), x1Lhs = lhsSpan.getX1();
            int const x0Rhs = rhsSpan.getX0(), x1Rhs = rhsSpan.getX1();
            int const xMin = std::max(x0Lhs, x0Rhs), xMax = std::min(x1Lhs, x1Rhs);
            if (xMin <= xMax) {
                lhsArray += xMin - x0Lhs;
                rhsArray += xMin - x0Rhs;
                for (int x = xMin; x <= xMax; ++x, ++lhsArray, ++rhsArray) {
                    sum += (*lhsArray) * (*rhsArray);
                }
                // Rewind to the start of the span, for easier sync between spans and arrays
                lhsArray -= xMax + 1 - x0Lhs;
                rhsArray -= xMax + 1 - x0Rhs;
            }
            if (x1Lhs <= x1Rhs) {
                lhsArray += lhsSpan.getWidth();
                ++lhsIter;
            } else {
                rhsArray += rhsSpan.getWidth();
                ++rhsIter;
            }
            continue;
        } else if (yLhs < yRhs) {
            while (lhsIter != lhsEnd && lhsIter->getY() < yRhs) {
                lhsArray += lhsIter->getWidth();
                ++lhsIter;
            }
            continue;
        } else {  // yLhs > yRhs
            while (rhsIter != rhsEnd && rhsIter->getY() < yLhs) {
                rhsArray += rhsIter->getWidth();
                ++rhsIter;
            }
            continue;
        }
    }
    return sum;
}

dynamicCast() [1/2]

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

                                                                                        {
    auto result = std::dynamic_pointer_cast<T>(ptr);
    if (!result) {
        throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
    }
    return result;
}

dynamicCast() [2/2]

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >::dynamicCast ( std::shared_ptr< Persistable > const &  ptr )

staticinherited

Dynamically cast a shared_ptr.

Dynamically cast a shared pointer and raise on failure.

You must provide an explicit template instantiation in the .cc file for each class that inherits from PersistableFacade. Designed to work around RTTI issues on macOS with hidden symbols;

Exceptions

lsst::pex::exceptions::LogicError

if the cast fails

param[in] ptr The pointer to be cast.

Returns

The cast pointer.

Exceptions

lsst::pex::exceptions::TypeError

If the dynamic cast fails.

Definition at line 18 of file Persistable.cc.

                                                                                        {
    auto result = std::dynamic_pointer_cast<T>(ptr);
    if (!result) {
        throw LSST_EXCEPT(pex::exceptions::TypeError, "Dynamic pointer cast failed");
    }
    return result;
}

erode() [1/2]

void lsst::afw::detection::Footprint::erode ( int  r, geom::Stencil  s = geom::Stencil::CIRCLE  )

inherited

Erode the Footprint with a defined kernel.

This function reduces the size of the SpanSet which defines the area of the Footprint by an amount governed by the input kernel

Parameters

r	The radius of the stencil object used to create a erosion kernel
s	The stencil object used to create the erosion kernel

Definition at line 129 of file Footprint.cc.

                                          {
    setSpans(getSpans()->eroded(r, s));
    removeOrphanPeaks();
}

erode() [2/2]

void lsst::afw::detection::Footprint::erode ( geom::SpanSet const &  other )

inherited

Erode the Footprint with a defined kernel.

This function reduces the size of the SpanSet which defines the area of the Footprint by an amount governed by the input kernel

Parameters

other

SpanSet to use as the kernel in erosion

Definition at line 134 of file Footprint.cc.

                                              {
    setSpans(getSpans()->eroded(other));
    removeOrphanPeaks();
}

getArea()

std::size_t lsst::afw::detection::Footprint::getArea ( ) const

inlineinherited

Return the number of pixels in this Footprint.

This function returns the real number of pixels, not the area of the bbox.

Definition at line 175 of file Footprint.h.

{ return _spans->getArea(); }

getBBox()

lsst::geom::Box2I lsst::afw::detection::Footprint::getBBox ( ) const

inlineinherited

Return the Footprint's bounding box.

Definition at line 210 of file Footprint.h.

{ return _spans->getBBox(); }

getCentroid()

lsst::geom::Point2D lsst::afw::detection::Footprint::getCentroid ( ) const

inlineinherited

Return the Footprint's centroid.

The centroid is calculated as the mean of the pixel centers

Definition at line 182 of file Footprint.h.

{ return _spans->computeCentroid(); }

getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 206 of file Citizen.cc.

{ return _CitizenId; }

getImageArray() [1/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

ndarray::Array<ImagePixelT, 1, 1> lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getImageArray ( )

inline

Definition at line 107 of file HeavyFootprint.h.

{ return _image; }

getImageArray() [2/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

ndarray::Array<ImagePixelT const, 1, 1> lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getImageArray ( ) const

inline

Definition at line 111 of file HeavyFootprint.h.

{ return _image; }

getMaskArray() [1/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

ndarray::Array<MaskPixelT, 1, 1> lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getMaskArray ( )

inline

Definition at line 108 of file HeavyFootprint.h.

{ return _mask; }

getMaskArray() [2/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

ndarray::Array<MaskPixelT const, 1, 1> lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getMaskArray ( ) const

inline

Definition at line 112 of file HeavyFootprint.h.

{ return _mask; }

getMaskBitsSet()

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

MaskPixelT lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getMaskBitsSet ( ) const

inline

Definition at line 116 of file HeavyFootprint.h.

                                      {
        MaskPixelT maskbits = 0;
        for (typename ndarray::Array<MaskPixelT, 1, 1>::Iterator i = _mask.begin(); i != _mask.end(); ++i) {
            maskbits |= *i;
        }
        return maskbits;
    }

getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 209 of file Citizen.cc.

{ return _nextMemId(); }

getPeaks() [1/2]

PeakCatalog& lsst::afw::detection::Footprint::getPeaks ( )

inlineinherited

Return the Peaks contained in this Footprint.

The peaks should be ordered by decreasing pixel intensity at the peak position (so the most negative peak appears last). Users that add new Peaks manually are responsible for maintaining this sorting.

Definition at line 131 of file Footprint.h.

{ return _peaks; }

getPeaks() [2/2]

const PeakCatalog& lsst::afw::detection::Footprint::getPeaks ( ) const

inlineinherited

Definition at line 132 of file Footprint.h.

{ return _peaks; }

getPersistenceName()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

std::string lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getPersistenceName ( ) const

overrideprotectedvirtual

Return the name correspoinging ot the persistence type.

Reimplemented from lsst::afw::detection::Footprint.

Definition at line 265 of file HeavyFootprint.cc.

                                                                                            {
    return "HeavyFootprint" + ComputeSuffix<ImagePixelT, MaskPixelT, VariancePixelT>::apply();
}

getPythonModule()

std::string lsst::afw::detection::Footprint::getPythonModule ( ) const

inlineoverrideprotectedvirtualinherited

Return the python module the object will live in.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 364 of file Footprint.h.

{ return "lsst.afw.detection"; }

getRegion()

lsst::geom::Box2I lsst::afw::detection::Footprint::getRegion ( ) const

inlineinherited

Return the corners of the MaskedImage the footprints live in.

Definition at line 215 of file Footprint.h.

{ return _region; }

getShape()

geom::ellipses::Quadrupole lsst::afw::detection::Footprint::getShape ( ) const

inlineinherited

Return the Footprint's shape (interpreted as an ellipse)

The shape is determined by measuring the moments of the pixel centers about its centroid (cf. getCentroid)

Definition at line 190 of file Footprint.h.

{ return _spans->computeShape(); }

getSpans()

std::shared_ptr<geom::SpanSet> lsst::afw::detection::Footprint::getSpans ( ) const

inlineinherited

Return a shared pointer to the SpanSet.

Definition at line 117 of file Footprint.h.

{ return _spans; }

getVarianceArray() [1/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

ndarray::Array<VariancePixelT, 1, 1> lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getVarianceArray ( )

inline

Definition at line 109 of file HeavyFootprint.h.

{ return _variance; }

getVarianceArray() [2/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

ndarray::Array<VariancePixelT const, 1, 1> lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::getVarianceArray ( ) const

inline

Definition at line 113 of file HeavyFootprint.h.

{ return _variance; }

hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 316 of file Citizen.cc.

                                      {
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin(); cur != _activeCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }
    for (table::iterator cur = _persistentCitizens.begin(); cur != _persistentCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }

    return false;
}

init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 196 of file Citizen.cc.

                         {
    volatile int dummy = 1;
    return dummy;
}

insert() [1/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

void lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::insert

(

lsst::afw::image::MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > &

mimage

)

const

Replace all the pixels in the image with the values in the HeavyFootprint.

Definition at line 119 of file HeavyFootprint.cc.

                                                                                 {
    getSpans()->unflatten(mimage.getImage()->getArray(), _image, mimage.getXY0());
    getSpans()->unflatten(mimage.getMask()->getArray(), _mask, mimage.getXY0());
    getSpans()->unflatten(mimage.getVariance()->getArray(), _variance, mimage.getXY0());
}

insert() [2/2]

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

void lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::insert

(

lsst::afw::image::Image< ImagePixelT > &

image

)

const

Replace all the pixels in the image with the values in the HeavyFootprint.

Parameters

[out]

image

Image to set

Definition at line 127 of file HeavyFootprint.cc.

                                                                                                         {
    getSpans()->unflatten(image.getArray(), _image, image.getXY0());
}

isContiguous()

bool lsst::afw::detection::Footprint::isContiguous ( ) const

inlineinherited

Reports if the Footprint is simply connected or has multiple components.

Definition at line 337 of file Footprint.h.

{ return getSpans()->isContiguous(); };

isHeavy()

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

bool lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::isHeavy ( ) const

inlineoverridevirtual

Is this a HeavyFootprint (yes!)

Reimplemented from lsst::afw::detection::Footprint.

Definition at line 93 of file HeavyFootprint.h.

{ return true; }

isPersistable()

bool lsst::afw::detection::Footprint::isPersistable ( ) const

inlineoverridevirtualnoexceptinherited

Report if this object is persistable.

Reimplemented from lsst::afw::table::io::Persistable.

Definition at line 285 of file Footprint.h.

{ return true; }

markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void  )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 225 of file Citizen.cc.

                                        {
    WriteGuard guard(citizenLock);
    _persistentCitizens[this] = _activeCitizens[this];
    _activeCitizens.erase(this);
}

operator=() [1/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

HeavyFootprint& lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > const &  )

default

operator=() [2/2]

template<typename ImagePixelT, typename MaskPixelT = lsst::afw::image::MaskPixel, typename VariancePixelT = lsst::afw::image::VariancePixel>

HeavyFootprint& lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::operator= ( HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > &&  )

default

operator==()

bool lsst::afw::detection::Footprint::operator== ( Footprint const &  other ) const

inherited

equality operator

Parameters

other

The Footprint for which equality will be computed

Definition at line 165 of file Footprint.cc.

                                                       {
    /* If the peakCatalogs are not the same length the Footprints can't be equal */
    if (getPeaks().size() != other.getPeaks().size()) {
        return false;
    }
    /* Check that for every peak in the PeakCatalog there is a corresponding peak
     * in the other, and if not return false
     */
    for (auto const& selfPeak : getPeaks()) {
        bool match = false;
        for (auto const& otherPeak : other.getPeaks()) {
            if (selfPeak.getI() == otherPeak.getI() && selfPeak.getF() == otherPeak.getF() &&
                selfPeak.getPeakValue() == otherPeak.getPeakValue()) {
                match = true;
                break;
            }
        }
        if (!match) {
            return false;
        }
    }
    /* At this point the PeakCatalogs have evaluated true, compare the SpanSets
     */
    return *(getSpans()) == *(other.getSpans());
}

readFits() [1/6]

static std::shared_ptr<lsst::afw::detection::Footprint > lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint >::readFits ( fits::Fits &  fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return dynamicCast(Persistable::_readFits(fitsfile));
    }

readFits() [2/6]

static std::shared_ptr<HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > lsst::afw::table::io::PersistableFacade< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >::readFits ( fits::Fits &  fitsfile )

inlinestaticinherited

Read an object from an already open FITS object.

Parameters

[in]

fitsfile

FITS object to read from, already positioned at the desired HDU.

Definition at line 183 of file Persistable.h.

                                                         {
        return dynamicCast(Persistable::_readFits(fitsfile));
    }

readFits() [3/6]

static std::shared_ptr<HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > lsst::afw::table::io::PersistableFacade< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >::readFits ( std::string const &  fileName, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

                                                                                           {
        return dynamicCast(Persistable::_readFits(fileName, hdu));
    }

readFits() [4/6]

static std::shared_ptr<lsst::afw::detection::Footprint > lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint >::readFits ( std::string const &  fileName, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a regular FITS file.

Parameters

[in]	fileName	Name of the file to read.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 194 of file Persistable.h.

                                                                                           {
        return dynamicCast(Persistable::_readFits(fileName, hdu));
    }

readFits() [5/6]

static std::shared_ptr<lsst::afw::detection::Footprint > lsst::afw::table::io::PersistableFacade< lsst::afw::detection::Footprint >::readFits ( fits::MemFileManager &  manager, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                                             {
        return dynamicCast(Persistable::_readFits(manager, hdu));
    }

readFits() [6/6]

static std::shared_ptr<HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > > lsst::afw::table::io::PersistableFacade< HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT > >::readFits ( fits::MemFileManager &  manager, int  hdu = fits::DEFAULT_HDU  )

inlinestaticinherited

Read an object from a FITS file in memory.

Parameters

[in]	manager	Manager for the memory to read from.
[in]	hdu	HDU to read, where 0 is the primary. The special value of afw::fits::DEFAULT_HDU skips the primary HDU if it is empty.

Definition at line 205 of file Persistable.h.

                                                                                             {
        return dynamicCast(Persistable::_readFits(manager, hdu));
    }

readPeaks()

void lsst::afw::detection::Footprint::readPeaks ( afw::table::BaseCatalog const &  peakCat, Footprint &  loadedFootprint  )

staticprotectedinherited

Static method used to unpersist the PeakCatalog member of the Footprint class.

Definition at line 302 of file Footprint.cc.

                                                                                        {
    using namespace std::string_literals;
    if (!peakCat.getSchema().contains(PeakTable::makeMinimalSchema())) {
        // need to handle an older form of Peak persistence for backwards compatibility
        afw::table::SchemaMapper mapper(peakCat.getSchema());
        mapper.addMinimalSchema(PeakTable::makeMinimalSchema());
        afw::table::Key<float> oldX = peakCat.getSchema()["x"];
        afw::table::Key<float> oldY = peakCat.getSchema()["y"];
        afw::table::Key<float> oldPeakValue = peakCat.getSchema()["value"];
        mapper.addMapping(oldX, "f.x"s);
        mapper.addMapping(oldY, "f.y"s);
        mapper.addMapping(oldPeakValue, "peakValue"s);
        loadedFootprint.setPeakSchema(mapper.getOutputSchema());
        auto peaks = loadedFootprint.getPeaks();
        peaks.reserve(peakCat.size());
        for (auto const& peak : peakCat) {
            auto newPeak = peaks.addNew();
            newPeak->assign(peak, mapper);
            newPeak->setIx(static_cast<int>(newPeak->getFx()));
            newPeak->setIy(static_cast<int>(newPeak->getFy()));
        }
        return;
    }
    loadedFootprint.setPeakSchema(peakCat.getSchema());
    auto& peaks = loadedFootprint.getPeaks();
    peaks.reserve(peakCat.size());
    for (auto const& peak : peakCat) {
        peaks.addNew()->assign(peak);
    }
}

readSpanSet()

std::unique_ptr< Footprint > lsst::afw::detection::Footprint::readSpanSet ( afw::table::BaseCatalog const &  catalog, afw::table::io::InputArchive const &  archive  )

staticprotectedinherited

Static method used to unpersist the SpanSet member of the Footprint class.

Definition at line 278 of file Footprint.cc.

                                                                                         {
    int fieldCount = catalog.getSchema().getFieldCount();
    LSST_ARCHIVE_ASSERT(fieldCount == 1 || fieldCount == 3);
    std::shared_ptr<geom::SpanSet> loadedSpanSet;
    if (fieldCount == 1) {
        // This is a new style footprint with a SpanSet as a member, treat accordingly
        auto const schemaAndKey = spanSetPersistenceHelper();
        int persistedSpanSetId = catalog.front().get(schemaAndKey.second);
        loadedSpanSet = std::dynamic_pointer_cast<geom::SpanSet>(archive.get(persistedSpanSetId));
    } else {
        // This block is for an old style footprint load.
        auto const& keys = LegacyFootprintPersistenceHelper::get();
        std::vector<geom::Span> tempVec;
        tempVec.reserve(catalog.size());
        for (auto const& val : catalog) {
            tempVec.push_back(geom::Span(val.get(keys.spanY), val.get(keys.spanX0), val.get(keys.spanX1)));
        }
        loadedSpanSet = std::make_shared<geom::SpanSet>(std::move(tempVec));
    }
    auto loadedFootprint = std::unique_ptr<Footprint>(new Footprint(loadedSpanSet));
    return loadedFootprint;
}

removeOrphanPeaks()

void lsst::afw::detection::Footprint::removeOrphanPeaks ( )

inherited

Remove peaks from the PeakCatalog that fall outside the area of the Footprint.

Definition at line 139 of file Footprint.cc.

                                  {
    for (auto iter = getPeaks().begin(); iter != getPeaks().end(); ++iter) {
        if (!getSpans()->contains(lsst::geom::Point2I(iter->getIx(), iter->getIy()))) {
            iter = getPeaks().erase(iter);
            --iter;
        }
    }
}

repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 219 of file Citizen.cc.

                                     {
    return boost::str(boost::format("%d: %08x %s") % _CitizenId % this %
                      lsst::utils::demangleType(_typeName));
}

setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback  func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 391 of file Citizen.cc.

  {
    Citizen::memCallback old = _corruptionCallback;
    _corruptionCallback = func;

    return old;
}

setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback  func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 381 of file Citizen.cc.

  {
    Citizen::memCallback old = _deleteCallback;
    _deleteCallback = func;

    return old;
}

setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId  id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 347 of file Citizen.cc.

  {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _deleteId;
    _deleteId = id;

    return oldId;
}

setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback  func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 371 of file Citizen.cc.

  {
    Citizen::memNewCallback old = _newCallback;
    _newCallback = func;

    return old;
}

setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId  id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 337 of file Citizen.cc.

  {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _newId;
    _newId = id;

    return oldId;
}

setPeakCatalog()

void lsst::afw::detection::Footprint::setPeakCatalog ( PeakCatalog const &  otherPeaks )

inherited

Set the peakCatalog to a copy of the supplied catalog.

PeakCatalog will be copied into the Footprint, but a PeakCatalog is a shallow copy, so records will not be duplicated. This function will throw an error if the PeakCatalog of *this is not empty.

Parameters

otherPeaks

The PeakCatalog to copy

Definition at line 425 of file Footprint.cc.

                                                            {
    if (!getPeaks().empty()) {
        throw LSST_EXCEPT(pex::exceptions::LogicError, "Cannot change the PeakCatalog unless it is empty");
    }
    // this syntax doesn't work in Python, which is why this method has to exist
    getPeaks() = otherPeaks;
}

setPeakSchema()

void lsst::afw::detection::Footprint::setPeakSchema ( afw::table::Schema const &  peakSchema )

inherited

Set the Schema used by the PeakCatalog (will throw if PeakCatalog is not empty).

Parameters

peakSchema

The schema to use in the PeakCatalog

Exceptions

pex::exceptions::LogicError

Thrown if if the PeakCatalog is not empty

Definition at line 421 of file Footprint.cc.

                                                              {
    setPeakCatalog(PeakCatalog(peakSchema));
}

setRegion()

void lsst::afw::detection::Footprint::setRegion ( lsst::geom::Box2I const &  region )

inlineinherited

Set the corners of the MaskedImage wherein the footprints dwell.

Parameters

region

A box describing the corners of the Image the Footprint derives from

Definition at line 222 of file Footprint.h.

{ _region = region; }

setSpans()

void lsst::afw::detection::Footprint::setSpans ( std::shared_ptr< geom::SpanSet >  otherSpanSet )

inherited

Sets the shared pointer to the SpanSet in the Footprint.

Parameters

otherSpanSet

Shared pointer to a SpanSet

Definition at line 48 of file Footprint.cc.

{ _spans = otherSpanSet; }

shift() [1/2]

void lsst::afw::detection::Footprint::shift ( int  dx, int  dy  )

inherited

Shift a Footprint by (dx, dy)

Parameters

dx	How much to move Footprint in column direction
dy	How much to move in row direction

Definition at line 67 of file Footprint.cc.

                                    {
    setSpans(getSpans()->shiftedBy(dx, dy));
    for (auto& peak : getPeaks()) {
        peak.setIx(peak.getIx() + dx);
        peak.setIy(peak.getIy() + dy);
        peak.setFx(peak.getFx() + dx);
        peak.setFy(peak.getFy() + dy);
    }
}

shift() [2/2]

void lsst::afw::detection::Footprint::shift ( lsst::geom::ExtentI const &  d )

inlineinherited

Shift a Footprint by a given extent.

Parameters

d	ExtentI object which gives the dimensions the Footprint should be shifted

Definition at line 205 of file Footprint.h.

{ shift(d.getX(), d.getY()); }

sortPeaks()

void lsst::afw::detection::Footprint::sortPeaks ( afw::table::Key< float > const &  key = afw::table::Key<float>() )

inherited

Sort Peaks from most positive value to most negative.

If the key passed is invalid (the default) PeakTable::getPeakValueKey() will be used.

Parameters

key	A key corresponding to the field in the Schema the PeakCatalog is to be sorted by.

Definition at line 60 of file Footprint.cc.

                                                       {
    auto validatedKey = key.isValid() ? key : PeakTable::getPeakValueKey();
    getPeaks().sort([&validatedKey](detection::PeakRecord const& a, detection::PeakRecord const& b) {
        return a.get(validatedKey) > b.get(validatedKey);
    });
}

split()

std::vector< std::shared_ptr< Footprint > > lsst::afw::detection::Footprint::split ( ) const

inherited

Split a multi-component Footprint into a vector of contiguous Footprints.

Split a multi-component Footprint such that each Footprint in the output vector is contiguous and contains only peaks that can be found within the bounds of the Footprint

Definition at line 148 of file Footprint.cc.

                                                           {
    auto splitSpanSets = getSpans()->split();
    std::vector<std::shared_ptr<Footprint>> footprintList;
    footprintList.reserve(splitSpanSets.size());
    for (auto& spanPtr : splitSpanSets) {
        auto tmpFootprintPointer = std::make_shared<Footprint>(spanPtr, getPeaks().getSchema(), getRegion());
        tmpFootprintPointer->_peaks = getPeaks();
        // No need to remove any peaks, as there is only one Footprint, so it will
        // simply be a copy of the original
        if (splitSpanSets.size() > 1) {
            tmpFootprintPointer->removeOrphanPeaks();
        }
        footprintList.push_back(std::move(tmpFootprintPointer));
    }
    return footprintList;
}

transform() [1/4]

std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform ( std::shared_ptr< geom::SkyWcs >  source, std::shared_ptr< geom::SkyWcs >  target, lsst::geom::Box2I const &  region, bool  doClip = true  ) const

inherited

Transform the footprint from one WCS to another.

Parameters

source	Wcs that defines the coordinate system of the input footprint.
target	Wcs that defines that desired coordinate system of the returned footprint.
region	Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClip	If true, clip the new footprint to the region bbox before returning it.

Definition at line 84 of file Footprint.cc.

                                                                                                {
    auto srcToTarget = geom::makeWcsPairTransform(*source, *target);
    return transform(*srcToTarget, region, doClip);
}

transform() [2/4]

std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform ( lsst::geom::LinearTransform const &  t, lsst::geom::Box2I const &  region, bool  doClip = true  ) const

inherited

Return a new Footprint whose pixels are the product of applying the specified transformation.

Parameters

t	A linear transform object which will be used to map the pixels
region	Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClip	If true, clip the new footprint to the region bbox before returning it.

Definition at line 91 of file Footprint.cc.

                                                                                                {
    return transform(lsst::geom::AffineTransform(t), region, doClip);
}

transform() [3/4]

std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform ( lsst::geom::AffineTransform const &  t, lsst::geom::Box2I const &  region, bool  doClip = true  ) const

inherited

Return a new Footprint whose pixels are the product of applying the specified transformation.

Parameters

t	An affine transform object which will be used to map the pixels
region	Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClip	If true, clip the new footprint to the region bbox before returning it.

Definition at line 96 of file Footprint.cc.

                                                                                                {
    return transform(*geom::makeTransform(t), region, doClip);
}

transform() [4/4]

std::shared_ptr< Footprint > lsst::afw::detection::Footprint::transform ( geom::TransformPoint2ToPoint2 const &  t, lsst::geom::Box2I const &  region, bool  doClip = true  ) const

inherited

Return a new Footprint whose pixels are the product of applying the specified transformation.

Parameters

t	A 2-D transform which will be used to map the pixels
region	Used to set the "region" box of the returned footprint; note that this is NOT the same as the footprint's bounding box.
doClip	If true, clip the new footprint to the region bbox before returning it.

Definition at line 101 of file Footprint.cc.

                                                                                                {
    // Transfrom the SpanSet first
    auto transformedSpan = getSpans()->transformedBy(t);
    // Use this new SpanSet and the peakSchema to create a new Footprint
    auto newFootprint = std::make_shared<Footprint>(transformedSpan, getPeaks().getSchema(), region);
    // now populate the new Footprint with transformed Peaks
    std::vector<lsst::geom::Point2D> peakPosList;
    peakPosList.reserve(_peaks.size());
    for (auto const& peak : getPeaks()) {
        peakPosList.emplace_back(peak.getF());
    }
    auto newPeakPosList = t.applyForward(peakPosList);
    auto newPeakPos = newPeakPosList.cbegin();
    for (auto peak = getPeaks().cbegin(), endPeak = getPeaks().cend(); peak != endPeak;
         ++peak, ++newPeakPos) {
        newFootprint->addPeak(newPeakPos->getX(), newPeakPos->getY(), peak->getPeakValue());
    }
    if (doClip) {
        newFootprint->clipTo(region);
    }
    return newFootprint;
}

write()

template<typename ImagePixelT , typename MaskPixelT , typename VariancePixelT >

void lsst::afw::detection::HeavyFootprint< ImagePixelT, MaskPixelT, VariancePixelT >::write ( OutputArchiveHandle &  handle ) const

overrideprotectedvirtual

Write an instance of a Footprint to an output Archive.

Reimplemented from lsst::afw::detection::Footprint.

Definition at line 270 of file HeavyFootprint.cc.

                                                                                                     {
    HeavyFootprintPersistenceHelper<ImagePixelT, MaskPixelT, VariancePixelT> const& keys =
            HeavyFootprintPersistenceHelper<ImagePixelT, MaskPixelT, VariancePixelT>::get();
    // delegate to Footprint::write to handle spans and peaks
    Footprint::write(handle);
    // add one more catalog for pixel values
    afw::table::BaseCatalog cat = handle.makeCatalog(keys.schema);
    std::shared_ptr<afw::table::BaseRecord> record = cat.addNew();
    // We could deep-copy the arrays instead of const-casting them, which might be marginally safer,
    // but we always save an OutputArchive to disk immediately after we create it, so there's really
    // no chance that we could get the HeavyFootprint in trouble by having this view modified.
    record->set(keys.image, ndarray::const_array_cast<ImagePixelT>(getImageArray()));
    record->set(keys.mask, ndarray::const_array_cast<MaskPixelT>(getMaskArray()));
    record->set(keys.variance, ndarray::const_array_cast<VariancePixelT>(getVarianceArray()));
    handle.saveCatalog(cat);
}

writeFits() [1/3]

void lsst::afw::table::io::Persistable::writeFits ( std::string const &  fileName, std::string const &  mode = "w"  ) const

inherited

Write the object to a regular FITS file.

Parameters

[in]	fileName	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 24 of file Persistable.cc.

                                                                                  {
    fits::Fits fitsfile(fileName, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [2/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::MemFileManager &  manager, std::string const &  mode = "w"  ) const

inherited

Write the object to a FITS image in memory.

Parameters

[in]	manager	Name of the file to write to.
[in]	mode	If "w", any existing file with the given name will be overwritten. If "a", new HDUs will be appended to an existing file.

Definition at line 29 of file Persistable.cc.

                                                                                    {
    fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
    writeFits(fitsfile);
}

writeFits() [3/3]

void lsst::afw::table::io::Persistable::writeFits ( fits::Fits &  fitsfile ) const

inherited

Write the object to an already-open FITS object.

Parameters

[in]

fitsfile

Open FITS object to write to.

Definition at line 18 of file Persistable.cc.

                                                    {
    OutputArchive archive;
    archive.put(this);
    archive.writeFits(fitsfile);
}

---

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

• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/include/lsst/afw/detection/HeavyFootprint.h
• /j/snowflake/release/lsstsw/stack/Linux64/afw/18.1.0/src/detection/HeavyFootprint.cc