Parameters to control convolution.
More...
#include <warpExposure.h>
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.
◆ OutputArchiveHandle
◆ WarpingControl()
Construct a WarpingControl object.
- Exceptions
-
- 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.
◆ ~WarpingControl()
virtual lsst::afw::math::WarpingControl::~WarpingControl |
( |
| ) |
|
|
inlinevirtual |
◆ dynamicCast()
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
-
param[in] ptr The pointer to be cast.
- Returns
- The cast pointer.
- Exceptions
-
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.
◆ getGrowFullMask()
get mask bits to grow to full width of image/variance kernel
Definition at line 391 of file warpExposure.h.
◆ getInterpLength()
int lsst::afw::math::WarpingControl::getInterpLength |
( |
| ) |
const |
|
inline |
◆ getMaskWarpingKernel()
◆ getPersistenceName()
std::string lsst::afw::math::WarpingControl::getPersistenceName |
( |
| ) |
const |
|
overrideprotectedvirtual |
◆ 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 372 of file warpExposure.cc.
◆ getWarpingKernel()
◆ hasMaskWarpingKernel()
bool lsst::afw::math::WarpingControl::hasMaskWarpingKernel |
( |
| ) |
const |
|
inline |
◆ isPersistable()
bool lsst::afw::math::WarpingControl::isPersistable |
( |
| ) |
const |
|
overridevirtualnoexcept |
◆ readFits() [1/3]
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]
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]
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
-
Definition at line 321 of file warpExposure.h.
◆ setGrowFullMask()
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.
◆ 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.
◆ 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 284 of file warpExposure.cc.
◆ 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 275 of file warpExposure.cc.
◆ setWarpingKernel()
void lsst::afw::math::WarpingControl::setWarpingKernel |
( |
SeparableKernel const & |
warpingKernel | ) |
|
set the warping kernel
- Exceptions
-
- Parameters
-
warpingKernel | warping kernel |
Definition at line 257 of file warpExposure.cc.
◆ 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 252 of file warpExposure.cc.
◆ write()
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 379 of file warpExposure.cc.
◆ 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.
◆ writeFits() [2/3]
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.
◆ 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.
The documentation for this class was generated from the following files: