lsst.sphgeom  20.0.0+2
Classes | Public Member Functions | List of all members
lsst::sphgeom::Chunker Class Reference

#include <Chunker.h>

Public Member Functions

 Chunker (int32_t numStripes, int32_t numSubStripesPerStripe)
 
bool operator== (Chunker const &c) const
 
bool operator!= (Chunker const &c) const
 
int32_t getNumStripes () const
 
int32_t getNumSubStripesPerStripe () const
 
std::vector< int32_t > getChunksIntersecting (Region const &r) const
 
std::vector< SubChunksgetSubChunksIntersecting (Region const &r) const
 
std::vector< int32_t > getAllChunks () const
 
std::vector< int32_t > getAllSubChunks (int32_t chunkId) const
 
bool valid (int32_t chunkId) const
 Return 'true' if the specified chunk number is valid.
 

Detailed Description

Chunker subdivides the unit sphere into longitude-latitude boxes.

The unit sphere is divided into latitude angle "stripes" of fixed height H. For each stripe, a width W is computed such that any two points in the stripe with longitude angles separated by at least W have angular separation of at least H. The stripe is then broken into an integral number of chunks of width at least W. The same procedure is used to obtain finer subchunks - each stripe is broken into a configureable number of equal-height "substripes", and each substripe is broken into equal-width subchunks.

Member Function Documentation

◆ getAllChunks()

std::vector< int32_t > lsst::sphgeom::Chunker::getAllChunks ( ) const

getAllChunks returns the complete set of chunk IDs for the unit sphere.

◆ getAllSubChunks()

std::vector< int32_t > lsst::sphgeom::Chunker::getAllSubChunks ( int32_t  chunkId) const

getAllSubChunks returns the complete set of sub-chunk IDs for the given chunk.

◆ getChunksIntersecting()

std::vector< int32_t > lsst::sphgeom::Chunker::getChunksIntersecting ( Region const &  r) const

getChunksIntersecting returns all the chunks that potentially intersect the given region.

◆ getNumStripes()

int32_t lsst::sphgeom::Chunker::getNumStripes ( ) const
inline

getNumStripes returns the number of fixed-height latitude intervals in the sky subdivision.

◆ getNumSubStripesPerStripe()

int32_t lsst::sphgeom::Chunker::getNumSubStripesPerStripe ( ) const
inline

getNumSubStripesPerStripe returns the number of fixed-height latitude sub-intervals in each stripe.

◆ getSubChunksIntersecting()

std::vector< SubChunks > lsst::sphgeom::Chunker::getSubChunksIntersecting ( Region const &  r) const

getSubChunksIntersecting returns all the sub-chunks that potentially intersect the given region.


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