lsst::afw::math::WarpingControl Class Reference

Parameters to control convolution. More...

#include <warpExposure.h>

Inheritance diagram for lsst::afw::math::WarpingControl:

Public Member Functions
	WarpingControl (std::string const &warpingKernelName, std::string const &maskWarpingKernelName="", int cacheSize=0, int interpLength=0, lsst::afw::image::MaskPixel growFullMask=0)
	Construct a WarpingControl object.
virtual	~WarpingControl ()
int	getCacheSize () const
	get the cache size for the interpolation kernel(s)
void	setCacheSize (int cacheSize)
	set the cache size for the interpolation kernel(s)
int	getInterpLength () const
	get the interpolation length (pixels)
void	setInterpLength (int interpLength)
	set the interpolation length
std::shared_ptr< SeparableKernel >	getWarpingKernel () const
	get the warping kernel
void	setWarpingKernelName (std::string const &warpingKernelName)
	set the warping kernel by name
void	setWarpingKernel (SeparableKernel const &warpingKernel)
	set the warping kernel
std::shared_ptr< SeparableKernel >	getMaskWarpingKernel () const
	get the mask warping kernel
bool	hasMaskWarpingKernel () const
	return true if there is a mask kernel
void	setMaskWarpingKernelName (std::string const &maskWarpingKernelName)
	set or clear the mask warping kernel by name
void	setMaskWarpingKernel (SeparableKernel const &maskWarpingKernel)
	set the mask warping kernel
lsst::afw::image::MaskPixel	getGrowFullMask () const
	get mask bits to grow to full width of image/variance kernel
void	setGrowFullMask (lsst::afw::image::MaskPixel growFullMask)
	set mask bits to grow to full width of image/variance kernel
bool	isPersistable () const noexcept override
	Return true if this particular object can be persisted using afw::table::io.
void	writeFits (std::string const &fileName, std::string const &mode="w") const
	Write the object to a regular FITS file.
void	writeFits (fits::MemFileManager &manager, std::string const &mode="w") const
	Write the object to a FITS image in memory.
void	writeFits (fits::Fits &fitsfile) const
	Write the object to an already-open FITS object.

Static Public Member Functions
static std::shared_ptr< WarpingControl >	readFits (fits::Fits &fitsfile)
	Read an object from an already open FITS object.
static std::shared_ptr< WarpingControl >	readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
	Read an object from a regular FITS file.
static std::shared_ptr< WarpingControl >	readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
	Read an object from a FITS file in memory.
static std::shared_ptr< WarpingControl >	dynamicCast (std::shared_ptr< Persistable > const &ptr)
	Dynamically cast a shared_ptr.

Protected Types
using	OutputArchiveHandle = io::OutputArchiveHandle

Protected Member Functions
std::string	getPersistenceName () const override
	Return the unique name used to persist this object and look up its factory.
std::string	getPythonModule () const override
	Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.
void	write (OutputArchiveHandle &handle) const override
	Write the object to one or more catalogs.

Detailed Description

Parameters to control convolution.

Note

padValue is not member of this class to avoid making this a templated class.

Definition at line 275 of file warpExposure.h.

Member Typedef Documentation

OutputArchiveHandle

using lsst::afw::table::io::Persistable::OutputArchiveHandle = io::OutputArchiveHandle

protectedinherited

Definition at line 108 of file Persistable.h.

Constructor & Destructor Documentation

WarpingControl()

lsst::afw::math::WarpingControl::WarpingControl ( std::string const & warpingKernelName, std::string const & maskWarpingKernelName = "", int cacheSize = 0, int interpLength = 0, lsst::afw::image::MaskPixel growFullMask = 0 )

inlineexplicit

Construct a WarpingControl object.

Exceptions

pex::exceptions::InvalidParameterError

if the warping kernel is smaller than the mask warping kernel.

Parameters

warpingKernelName	name of warping kernel; used as the argument to makeWarpingKernel
maskWarpingKernelName	name of warping kernel used for the mask plane; if "" then the regular warping kernel is used. Intended so one can use a bilinear kernel or other compact kernel for the mask plane to avoid smearing mask bits too far. The theory is that bad pixels are already interpolated over, so we don't need to worry about bad values spreading very far.
cacheSize	cache size for warping kernel; no cache if 0 (used as the argument to the warping kernels' computeCache method)
interpLength	distance over which the WCS can be linearly interpolated
growFullMask	mask bits to grow to full width of image/variance kernel

Definition at line 284 of file warpExposure.h.

            : _warpingKernelPtr(makeWarpingKernel(warpingKernelName)),
              _maskWarpingKernelPtr(),
              _cacheSize(cacheSize),
              _interpLength(interpLength),
              _growFullMask(growFullMask) {
        setMaskWarpingKernelName(maskWarpingKernelName);
    }

~WarpingControl()

virtual lsst::afw::math::WarpingControl::~WarpingControl ( )

inlinevirtual

Definition at line 306 of file warpExposure.h.

{};

Member Function Documentation

dynamicCast()

template std::shared_ptr< meas::extensions::psfex::PsfexPsf > lsst::afw::table::io::PersistableFacade< WarpingControl >::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 218 of file Persistable.cc.

getCacheSize()

int lsst::afw::math::WarpingControl::getCacheSize ( ) const

inline

get the cache size for the interpolation kernel(s)

Definition at line 311 of file warpExposure.h.

{ return _cacheSize; };

getGrowFullMask()

lsst::afw::image::MaskPixel lsst::afw::math::WarpingControl::getGrowFullMask ( ) const

inline

get mask bits to grow to full width of image/variance kernel

Definition at line 391 of file warpExposure.h.

{ return _growFullMask; };

getInterpLength()

int lsst::afw::math::WarpingControl::getInterpLength ( ) const

inline

get the interpolation length (pixels)

Definition at line 329 of file warpExposure.h.

{ return _interpLength; };

getMaskWarpingKernel()

std::shared_ptr< SeparableKernel > lsst::afw::math::WarpingControl::getMaskWarpingKernel

(

)

const

get the mask warping kernel

Definition at line 262 of file warpExposure.cc.

                                                                          {
    if (_maskWarpingKernelPtr) {  // lazily update kernel cache
        if (_maskWarpingKernelPtr->getCacheSize() != _cacheSize) {
            _maskWarpingKernelPtr->computeCache(_cacheSize);
        }
    }
    return _maskWarpingKernelPtr;
}

getPersistenceName()

std::string lsst::afw::math::WarpingControl::getPersistenceName ( ) const

overrideprotectedvirtual

Return the unique name used to persist this object and look up its factory.

Must be less than ArchiveIndexSchema::MAX_NAME_LENGTH characters.

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

Definition at line 366 of file warpExposure.cc.

{ return _getWarpingControlPersistenceName(); }

getPythonModule()

std::string lsst::afw::math::WarpingControl::getPythonModule ( ) const

overrideprotectedvirtual

Return the fully-qualified Python module that should be imported to guarantee that its factory is registered.

Must be less than ArchiveIndexSchema::MAX_MODULE_LENGTH characters.

Will be ignored if empty.

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

Definition at line 368 of file warpExposure.cc.

{ return "lsst.afw.math"; }

getWarpingKernel()

std::shared_ptr< SeparableKernel > lsst::afw::math::WarpingControl::getWarpingKernel

(

)

const

get the warping kernel

Definition at line 241 of file warpExposure.cc.

                                                                      {
    if (_warpingKernelPtr->getCacheSize() != _cacheSize) {
        _warpingKernelPtr->computeCache(_cacheSize);
    }
    return _warpingKernelPtr;
};

hasMaskWarpingKernel()

bool lsst::afw::math::WarpingControl::hasMaskWarpingKernel ( ) const

inline

return true if there is a mask kernel

Definition at line 371 of file warpExposure.h.

{ return static_cast<bool>(_maskWarpingKernelPtr); }

isPersistable()

bool lsst::afw::math::WarpingControl::isPersistable ( ) const

overridevirtualnoexcept

Return true if this particular object can be persisted using afw::table::io.

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

Definition at line 370 of file warpExposure.cc.

                                                  {
    return _warpingKernelPtr->isPersistable() &&
           (!hasMaskWarpingKernel() || _maskWarpingKernelPtr->isPersistable());
}

readFits() [1/3]

static std::shared_ptr< WarpingControl > lsst::afw::table::io::PersistableFacade< WarpingControl >::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.

readFits() [2/3]

static std::shared_ptr< WarpingControl > lsst::afw::table::io::PersistableFacade< WarpingControl >::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.

readFits() [3/3]

static std::shared_ptr< WarpingControl > lsst::afw::table::io::PersistableFacade< WarpingControl >::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.

setCacheSize()

void lsst::afw::math::WarpingControl::setCacheSize ( int cacheSize )

inline

set the cache size for the interpolation kernel(s)

A value of 0 disables the cache for maximum accuracy. 10,000 typically results in a warping error of a fraction of a count. 100,000 typically results in a warping error of less than 0.01 count. Note the new cache is not computed until getWarpingKernel or getMaskWarpingKernel is called.

Parameters

cacheSize

cache size

Definition at line 321 of file warpExposure.h.

      {
        _cacheSize = cacheSize;
    };

setGrowFullMask()

void lsst::afw::math::WarpingControl::setGrowFullMask ( lsst::afw::image::MaskPixel growFullMask )

inline

set mask bits to grow to full width of image/variance kernel

Parameters

growFullMask

mask bits to grow to full width of image/variance kernel

Definition at line 396 of file warpExposure.h.

      {
        _growFullMask = growFullMask;
    }

setInterpLength()

void lsst::afw::math::WarpingControl::setInterpLength ( int interpLength )

inline

set the interpolation length

Interpolation length is the distance over which the WCS can be linearly interpolated, in pixels:

• 0 means no interpolation and uses an optimized branch of the code
• 1 also performs no interpolation but it runs the interpolation code branch (and so is only intended for unit tests)

Parameters

interpLength

interpolation length (pixels)

Definition at line 339 of file warpExposure.h.

      {
        _interpLength = interpLength;
    };

setMaskWarpingKernel()

void lsst::afw::math::WarpingControl::setMaskWarpingKernel

(

SeparableKernel const &

maskWarpingKernel

)

set the mask warping kernel

Note

To clear the mask warping kernel use setMaskWarpingKernelName("").

Parameters

maskWarpingKernel

mask warping kernel

Definition at line 280 of file warpExposure.cc.

                                                                                  {
    _testWarpingKernels(*_warpingKernelPtr, maskWarpingKernel);
    _maskWarpingKernelPtr = std::static_pointer_cast<SeparableKernel>(maskWarpingKernel.clone());
}

setMaskWarpingKernelName()

void lsst::afw::math::WarpingControl::setMaskWarpingKernelName

(

std::string const &

maskWarpingKernelName

)

set or clear the mask warping kernel by name

Parameters

maskWarpingKernelName

name of mask warping kernel; use "" to clear the kernel

Definition at line 271 of file warpExposure.cc.

                                                                                    {
    if (!maskWarpingKernelName.empty()) {
        std::shared_ptr<SeparableKernel> maskWarpingKernelPtr(makeWarpingKernel(maskWarpingKernelName));
        setMaskWarpingKernel(*maskWarpingKernelPtr);
    } else {
        _maskWarpingKernelPtr.reset();
    }
}

setWarpingKernel()

void lsst::afw::math::WarpingControl::setWarpingKernel

(

SeparableKernel const &

warpingKernel

)

set the warping kernel

Exceptions

lsst::pex::exceptions::InvalidParameterError

if new kernel pointer is empty.

Parameters

warpingKernel

warping kernel

Definition at line 253 of file warpExposure.cc.

                                                                          {
    if (_maskWarpingKernelPtr) {
        _testWarpingKernels(warpingKernel, *_maskWarpingKernelPtr);
    }
    std::shared_ptr<SeparableKernel> warpingKernelPtr(
            std::static_pointer_cast<SeparableKernel>(warpingKernel.clone()));
    _warpingKernelPtr = warpingKernelPtr;
}

setWarpingKernelName()

void lsst::afw::math::WarpingControl::setWarpingKernelName

(

std::string const &

warpingKernelName

)

set the warping kernel by name

Parameters

warpingKernelName

name of warping kernel

Definition at line 248 of file warpExposure.cc.

                                                                            {
    std::shared_ptr<SeparableKernel> warpingKernelPtr(makeWarpingKernel(warpingKernelName));
    setWarpingKernel(*warpingKernelPtr);
}

write()

void lsst::afw::math::WarpingControl::write ( OutputArchiveHandle & handle ) const

overrideprotectedvirtual

Write the object to one or more catalogs.

The handle object passed to this function provides an interface for adding new catalogs and adding nested objects to the same archive (while checking for duplicates). See OutputArchiveHandle for more information.

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

Definition at line 375 of file warpExposure.cc.

                                                            {
    auto const &keys = WarpingControlPersistenceHelper::get();
    table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
    std::shared_ptr<table::BaseRecord> record = catalog.addNew();
 
    record->set(keys.warpingKernelIndex, handle.put(_warpingKernelPtr));
    record->set(keys.hasMaskKernel, hasMaskWarpingKernel());
    if (hasMaskWarpingKernel()) {
        record->set(keys.maskKernelIndex, handle.put(_maskWarpingKernelPtr));
    }
    record->set(keys.cacheSize, _cacheSize);
    record->set(keys.interpLength, _interpLength);
    record->set(keys.growFullMask, _growFullMask);
 
    handle.saveCatalog(catalog);
}

writeFits() [1/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);
}

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 ( 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);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+0a71e47438/include/lsst/afw/math/warpExposure.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/afw/gef2f8181fd+0a71e47438/src/math/warpExposure.cc