LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
Parameters to control convolution. More...
#include <warpExposure.h>
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. More... | |
virtual | ~WarpingControl () |
int | getCacheSize () const |
get the cache size for the interpolation kernel(s) More... | |
void | setCacheSize (int cacheSize) |
set the cache size for the interpolation kernel(s) More... | |
int | getInterpLength () const |
get the interpolation length (pixels) More... | |
void | setInterpLength (int interpLength) |
set the interpolation length More... | |
std::shared_ptr< SeparableKernel > | getWarpingKernel () const |
get the warping kernel More... | |
void | setWarpingKernelName (std::string const &warpingKernelName) |
set the warping kernel by name More... | |
void | setWarpingKernel (SeparableKernel const &warpingKernel) |
set the warping kernel More... | |
std::shared_ptr< SeparableKernel > | getMaskWarpingKernel () const |
get the mask warping kernel More... | |
bool | hasMaskWarpingKernel () const |
return true if there is a mask kernel More... | |
void | setMaskWarpingKernelName (std::string const &maskWarpingKernelName) |
set or clear the mask warping kernel by name More... | |
void | setMaskWarpingKernel (SeparableKernel const &maskWarpingKernel) |
set the mask warping kernel More... | |
lsst::afw::image::MaskPixel | getGrowFullMask () const |
get mask bits to grow to full width of image/variance kernel More... | |
void | setGrowFullMask (lsst::afw::image::MaskPixel growFullMask) |
set mask bits to grow to full width of image/variance kernel More... | |
bool | isPersistable () const noexcept override |
Return true if this particular object can be persisted using afw::table::io. 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< WarpingControl > | readFits (fits::Fits &fitsfile) |
Read an object from an already open FITS object. More... | |
static std::shared_ptr< WarpingControl > | readFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU) |
Read an object from a regular FITS file. More... | |
static std::shared_ptr< WarpingControl > | readFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU) |
Read an object from a FITS file in memory. More... | |
static std::shared_ptr< WarpingControl > | dynamicCast (std::shared_ptr< Persistable > const &ptr) |
Dynamically cast a shared_ptr. More... | |
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. More... | |
std::string | getPythonModule () const override |
Return the fully-qualified Python module that should be imported to guarantee that its factory is registered. More... | |
void | write (OutputArchiveHandle &handle) const override |
Write the object to one or more catalogs. More... | |
Parameters to control convolution.
Definition at line 275 of file warpExposure.h.
|
protectedinherited |
Definition at line 108 of file Persistable.h.
|
inlineexplicit |
Construct a WarpingControl object.
pex::exceptions::InvalidParameterError | if the warping kernel is smaller than the mask warping kernel. |
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.
|
inlinevirtual |
Definition at line 306 of file warpExposure.h.
|
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;
lsst::pex::exceptions::LogicError | if the cast fails |
param[in] ptr The pointer to be cast.
lsst::pex::exceptions::TypeError | If the dynamic cast fails. |
Definition at line 218 of file Persistable.cc.
|
inline |
get the cache size for the interpolation kernel(s)
Definition at line 311 of file warpExposure.h.
|
inline |
get mask bits to grow to full width of image/variance kernel
Definition at line 391 of file warpExposure.h.
|
inline |
get the interpolation length (pixels)
Definition at line 329 of file warpExposure.h.
std::shared_ptr< SeparableKernel > lsst::afw::math::WarpingControl::getMaskWarpingKernel | ( | ) | const |
get the mask warping kernel
Definition at line 262 of file warpExposure.cc.
|
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.
|
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.
std::shared_ptr< SeparableKernel > lsst::afw::math::WarpingControl::getWarpingKernel | ( | ) | const |
get the warping kernel
Definition at line 241 of file warpExposure.cc.
|
inline |
return true if there is a mask kernel
Definition at line 371 of file warpExposure.h.
|
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.
|
inlinestaticinherited |
Read an object from an already open FITS object.
[in] | fitsfile | FITS object to read from, already positioned at the desired HDU. |
Definition at line 183 of file Persistable.h.
|
inlinestaticinherited |
Read an object from a FITS file in memory.
[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.
|
inlinestaticinherited |
Read an object from a regular FITS file.
[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.
|
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.
cacheSize | cache size |
Definition at line 321 of file warpExposure.h.
|
inline |
set mask bits to grow to full width of image/variance kernel
growFullMask | mask bits to grow to full width of image/variance kernel |
Definition at line 396 of file warpExposure.h.
|
inline |
set the interpolation length
Interpolation length is the distance over which the WCS can be linearly interpolated, in pixels:
interpLength | interpolation length (pixels) |
Definition at line 339 of file warpExposure.h.
void lsst::afw::math::WarpingControl::setMaskWarpingKernel | ( | SeparableKernel const & | maskWarpingKernel | ) |
set the mask warping kernel
maskWarpingKernel | mask warping kernel |
Definition at line 280 of file warpExposure.cc.
void lsst::afw::math::WarpingControl::setMaskWarpingKernelName | ( | std::string const & | maskWarpingKernelName | ) |
set or clear the mask warping kernel by name
maskWarpingKernelName | name of mask warping kernel; use "" to clear the kernel |
Definition at line 271 of file warpExposure.cc.
void lsst::afw::math::WarpingControl::setWarpingKernel | ( | SeparableKernel const & | warpingKernel | ) |
set the warping kernel
lsst::pex::exceptions::InvalidParameterError | if new kernel pointer is empty. |
warpingKernel | warping kernel |
Definition at line 253 of file warpExposure.cc.
void lsst::afw::math::WarpingControl::setWarpingKernelName | ( | std::string const & | warpingKernelName | ) |
set the warping kernel by name
warpingKernelName | name of warping kernel |
Definition at line 248 of file warpExposure.cc.
|
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.
|
inherited |
Write the object to an already-open FITS object.
[in] | fitsfile | Open FITS object to write to. |
Definition at line 18 of file Persistable.cc.
|
inherited |
Write the object to a FITS image in memory.
[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.
|
inherited |
Write the object to a regular FITS file.
[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.