LSST Applications g1cfbe01172+01aa18f939,g20cdd03214+31e6b93548,g28da252d5a+ea8665a95b,g2bbee38e9b+9ec6cc348d,g2bc492864f+9ec6cc348d,g347aa1857d+9ec6cc348d,g3a166c0a6a+9ec6cc348d,g4322eb9e3a+65eff1e020,g461a3dce89+b86e4b8053,g50ff169b8f+f991eae79d,g52b1c1532d+b86e4b8053,g607f77f49a+31e6b93548,g78056777b3+8ae2798781,g858d7b2824+31e6b93548,g8cd86fa7b1+4851e61ca4,g9ddcbc5298+f24b38b85a,ga1e77700b3+3309dba821,gae0086650b+b86e4b8053,gb0e22166c9+6076c0b52b,gbb886bcc26+dccb771098,gbd462c55f0+dc07f8e65d,gc0c51c7ec2+31e6b93548,gc120e1dc64+a417ce3171,gc28159a63d+9ec6cc348d,gc2a6998b7e+f95f64aeae,gcdd4ae20e8+507450c4cd,gcf0d15dbbd+507450c4cd,gd1535ee943+bcf88ba65f,gd598c5cd71+66126f91fb,gdaeeff99f8+006e14e809,gdbce86181e+39d5515b1a,ge3d4d395c2+b12d4d6a95,ge79ae78c31+9ec6cc348d,gf048a9a2f4+d9c36e6b63,gfbcc870c63+ea41c4420b,w.2024.27
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
lsst::afw::math::WarpingControl Class Referencefinal

Parameters to control convolution. More...

#include <warpExposure.h>

Inheritance diagram for lsst::afw::math::WarpingControl:
lsst::afw::table::io::PersistableFacade< WarpingControl > lsst::afw::table::io::Persistable

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< SeparableKernelgetWarpingKernel () 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< SeparableKernelgetMaskWarpingKernel () 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< WarpingControlreadFits (fits::Fits &fitsfile)
 Read an object from an already open FITS object.
 
static std::shared_ptr< WarpingControlreadFits (std::string const &fileName, int hdu=fits::DEFAULT_HDU)
 Read an object from a regular FITS file.
 
static std::shared_ptr< WarpingControlreadFits (fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
 Read an object from a FITS file in memory.
 
static std::shared_ptr< WarpingControldynamicCast (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::InvalidParameterErrorif the warping kernel is smaller than the mask warping kernel.
Parameters
warpingKernelNamename of warping kernel; used as the argument to makeWarpingKernel
maskWarpingKernelNamename 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.
cacheSizecache size for warping kernel; no cache if 0 (used as the argument to the warping kernels' computeCache method)
interpLengthdistance over which the WCS can be linearly interpolated
growFullMaskmask bits to grow to full width of image/variance kernel

Definition at line 284 of file warpExposure.h.

298 : _warpingKernelPtr(makeWarpingKernel(warpingKernelName)),
299 _maskWarpingKernelPtr(),
300 _cacheSize(cacheSize),
301 _interpLength(interpLength),
302 _growFullMask(growFullMask) {
303 setMaskWarpingKernelName(maskWarpingKernelName);
304 }
void setMaskWarpingKernelName(std::string const &maskWarpingKernelName)
set or clear the mask warping kernel by name
std::shared_ptr< SeparableKernel > makeWarpingKernel(std::string name)
Return a warping kernel given its name.
afw::table::Key< std::string > warpingKernelName
Definition CoaddPsf.cc:355
table::Key< int > interpLength
table::Key< image::MaskPixel > growFullMask
table::Key< int > cacheSize

◆ ~WarpingControl()

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

Definition at line 306 of file warpExposure.h.

306{};

Member Function Documentation

◆ 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
lsst::pex::exceptions::LogicErrorif the cast fails

param[in] ptr The pointer to be cast.

Returns
The cast pointer.
Exceptions
lsst::pex::exceptions::TypeErrorIf 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.

311{ 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.

391{ return _growFullMask; };

◆ getInterpLength()

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

get the interpolation length (pixels)

Definition at line 329 of file warpExposure.h.

329{ 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.

262 {
263 if (_maskWarpingKernelPtr) { // lazily update kernel cache
264 if (_maskWarpingKernelPtr->getCacheSize() != _cacheSize) {
265 _maskWarpingKernelPtr->computeCache(_cacheSize);
266 }
267 }
268 return _maskWarpingKernelPtr;
269}

◆ 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.

366{ 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.

368{ 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.

241 {
242 if (_warpingKernelPtr->getCacheSize() != _cacheSize) {
243 _warpingKernelPtr->computeCache(_cacheSize);
244 }
245 return _warpingKernelPtr;
246};

◆ 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.

371{ 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.

370 {
371 return _warpingKernelPtr->isPersistable() &&
372 (!hasMaskWarpingKernel() || _maskWarpingKernelPtr->isPersistable());
373}
bool hasMaskWarpingKernel() const
return true if there is a mask kernel

◆ 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]fitsfileFITS 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]managerManager for the memory to read from.
[in]hduHDU 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]fileNameName of the file to read.
[in]hduHDU 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
cacheSizecache size

Definition at line 321 of file warpExposure.h.

322 {
323 _cacheSize = cacheSize;
324 };

◆ 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
growFullMaskmask bits to grow to full width of image/variance kernel

Definition at line 396 of file warpExposure.h.

398 {
399 _growFullMask = growFullMask;
400 }

◆ 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
interpLengthinterpolation length (pixels)

Definition at line 339 of file warpExposure.h.

340 {
341 _interpLength = interpLength;
342 };

◆ 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
maskWarpingKernelmask warping kernel

Definition at line 280 of file warpExposure.cc.

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

◆ setMaskWarpingKernelName()

void lsst::afw::math::WarpingControl::setMaskWarpingKernelName ( std::string const & maskWarpingKernelName)

set or clear the mask warping kernel by name

Parameters
maskWarpingKernelNamename of mask warping kernel; use "" to clear the kernel

Definition at line 271 of file warpExposure.cc.

271 {
272 if (!maskWarpingKernelName.empty()) {
273 std::shared_ptr<SeparableKernel> maskWarpingKernelPtr(makeWarpingKernel(maskWarpingKernelName));
274 setMaskWarpingKernel(*maskWarpingKernelPtr);
275 } else {
276 _maskWarpingKernelPtr.reset();
277 }
278}
void setMaskWarpingKernel(SeparableKernel const &maskWarpingKernel)
set the mask warping kernel

◆ setWarpingKernel()

void lsst::afw::math::WarpingControl::setWarpingKernel ( SeparableKernel const & warpingKernel)

set the warping kernel

Exceptions
lsst::pex::exceptions::InvalidParameterErrorif new kernel pointer is empty.
Parameters
warpingKernelwarping kernel

Definition at line 253 of file warpExposure.cc.

253 {
254 if (_maskWarpingKernelPtr) {
255 _testWarpingKernels(warpingKernel, *_maskWarpingKernelPtr);
256 }
257 std::shared_ptr<SeparableKernel> warpingKernelPtr(
258 std::static_pointer_cast<SeparableKernel>(warpingKernel.clone()));
259 _warpingKernelPtr = warpingKernelPtr;
260}

◆ setWarpingKernelName()

void lsst::afw::math::WarpingControl::setWarpingKernelName ( std::string const & warpingKernelName)

set the warping kernel by name

Parameters
warpingKernelNamename of warping kernel

Definition at line 248 of file warpExposure.cc.

248 {
250 setWarpingKernel(*warpingKernelPtr);
251}
void setWarpingKernel(SeparableKernel const &warpingKernel)
set the warping kernel

◆ 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.

375 {
376 auto const &keys = WarpingControlPersistenceHelper::get();
377 table::BaseCatalog catalog = handle.makeCatalog(keys.schema);
378 std::shared_ptr<table::BaseRecord> record = catalog.addNew();
379
380 record->set(keys.warpingKernelIndex, handle.put(_warpingKernelPtr));
381 record->set(keys.hasMaskKernel, hasMaskWarpingKernel());
382 if (hasMaskWarpingKernel()) {
383 record->set(keys.maskKernelIndex, handle.put(_maskWarpingKernelPtr));
384 }
385 record->set(keys.cacheSize, _cacheSize);
386 record->set(keys.interpLength, _interpLength);
387 record->set(keys.growFullMask, _growFullMask);
388
389 handle.saveCatalog(catalog);
390}
CatalogT< BaseRecord > BaseCatalog
Definition fwd.h:72

◆ 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]fitsfileOpen FITS object to write to.

Definition at line 18 of file Persistable.cc.

18 {
19 OutputArchive archive;
20 archive.put(this);
21 archive.writeFits(fitsfile);
22}

◆ 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]managerName of the file to write to.
[in]modeIf "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.

29 {
30 fits::Fits fitsfile(manager, mode, fits::Fits::AUTO_CLOSE | fits::Fits::AUTO_CHECK);
31 writeFits(fitsfile);
32}
void writeFits(std::string const &fileName, std::string const &mode="w") const
Write the object to a regular FITS file.

◆ 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]fileNameName of the file to write to.
[in]modeIf "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.

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

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