lsst::ap::ZoneIndex< EntryT > Class Template Reference

Container for a sequence of adjacent zones. More...

#include <ZoneTypes.h>

Inheritance diagram for lsst::ap::ZoneIndex< EntryT >:

Public Types
typedef EntryT::Chunk	Chunk
typedef EntryT::Data	Data
typedef ZoneEntryArray< EntryT >	Zone
Public Types inherited from lsst::daf::base::Citizen
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback )(const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback )(const Citizen *ptr)

Public Member Functions
	ZoneIndex (int const zonesPerDegree, int const zonesPerStripe, int const maxEntriesPerZoneEstimate)
void	clear ()
	Removes all entries from every zone in the index. More...
int	size () const
	Returns the number of entries in the index. More...
void	setDecBounds (double const minDec, double const maxDec)
	Sets the range of declination values the index will accept data for. More...
void	computeMatchParams (double const radius)
	Prepares for distance based matches of the given maximum radius. More...
void	sort ()
	Sorts each zone in the index (on right ascension) More...
template<typename FilterT >
int	pack (FilterT &filter)
template<typename FunctionT >
void	apply (FunctionT &function)
void	insert (double const ra, double const dec, Data *const data, Chunk *const chunk, int const index)
int	getMinZone () const
int	getMaxZone () const
Zone *	getZone (int const zone)
Zone *	firstZone (int const minZone, int const maxZone)
Zone *	endZone (int const minZone, int const maxZone)
ZoneStripeChunkDecomposition const &	getDecomposition () const
Public Member Functions inherited from lsst::daf::base::Citizen
	Citizen (const std::type_info &)
	Citizen (Citizen const &)
	~Citizen ()
Citizen &	operator= (Citizen const &)
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Private Attributes
ZoneStripeChunkDecomposition	_zsc
boost::scoped_array< Zone >	_zones
int	_capacity
int	_minZone
int	_maxZone

Additional Inherited Members
Static Public Member Functions inherited from lsst::daf::base::Citizen
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector < const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

template<typename EntryT>
class lsst::ap::ZoneIndex< EntryT >

Container for a sequence of adjacent zones.

Definition at line 199 of file ZoneTypes.h.

Member Typedef Documentation

template<typename EntryT>

typedef EntryT::Chunk lsst::ap::ZoneIndex< EntryT >::Chunk

Definition at line 205 of file ZoneTypes.h.

template<typename EntryT>

typedef EntryT::Data lsst::ap::ZoneIndex< EntryT >::Data

Definition at line 206 of file ZoneTypes.h.

template<typename EntryT>

typedef ZoneEntryArray<EntryT> lsst::ap::ZoneIndex< EntryT >::Zone

Definition at line 207 of file ZoneTypes.h.

Constructor & Destructor Documentation

template<typename EntryT >

lsst::ap::ZoneIndex< EntryT >::ZoneIndex	(	int const	zonesPerDegree,
		int const	zonesPerStripe,
		int const	maxEntriesPerZoneEstimate
	)

Definition at line 189 of file ZoneTypes.cc.

  :
    lsst::daf::base::Citizen(typeid(*this)),
    _zsc(zonesPerDegree, zonesPerStripe, maxEntriesPerZoneEstimate),
    _zones(),
    _capacity(0),
    _minZone(0),
    _maxZone(-1)
{}

Member Function Documentation

template<typename EntryT >

template<typename FunctionT >

void lsst::ap::ZoneIndex< EntryT >::apply

(

FunctionT &

function

)

Calls a functor implementing

void operator()(EntryT const &) 

on every entry in the index.

Definition at line 321 of file ZoneTypes.cc.

                                                        {
    int const numZones = _maxZone - _minZone + 1;
    for (int z = 0; z < numZones; ++z) {
        _zones[z].apply<FunctionT>(function);
    }
}

template<typename EntryT >

void lsst::ap::ZoneIndex< EntryT >::clear

(

)

Removes all entries from every zone in the index.

Definition at line 205 of file ZoneTypes.cc.

                                    {
    for (int i = 0; i < _capacity; ++i) {
        _zones[i].clear();
    }
}

template<typename EntryT >

void lsst::ap::ZoneIndex< EntryT >::computeMatchParams

(

double const

radius

)

Prepares for distance based matches of the given maximum radius.

Definition at line 269 of file ZoneTypes.cc.

                                                                    {
    int const numZones = _maxZone - _minZone + 1;
    for (int t = 0; t < numZones; ++t) {
        _zones[t].computeMatchParams(_zsc, radius);
    }
}

template<typename EntryT>

Zone* lsst::ap::ZoneIndex< EntryT >::endZone ( int const  minZone, int const  maxZone  )

inline

Returns a pointer to the zone following the last zone in the index within the given id range, or 0 if there is no such zone.

Definition at line 271 of file ZoneTypes.h.

                                                         {
        if (maxZone < _minZone || minZone > _maxZone) {
            return 0;
        }
        if (maxZone >= _maxZone) {
            return &_zones[_maxZone - _minZone + 1];
        }
        return &_zones[maxZone - _minZone + 1];
    }

template<typename EntryT>

Zone* lsst::ap::ZoneIndex< EntryT >::firstZone ( int const  minZone, int const  maxZone  )

inline

Returns a pointer to the first zone in the index within the given id range, or 0 if there is no such zone.

Definition at line 257 of file ZoneTypes.h.

                                                           {
        if (maxZone < _minZone || minZone > _maxZone) {
            return 0;
        }
        if (minZone <= _minZone) {
            return _zones.get();
        }
        return &_zones[minZone - _minZone];
    }

template<typename EntryT>

ZoneStripeChunkDecomposition const& lsst::ap::ZoneIndex< EntryT >::getDecomposition ( ) const

inline

Definition at line 281 of file ZoneTypes.h.

                                                                  {
        return _zsc;
    }

template<typename EntryT>

int lsst::ap::ZoneIndex< EntryT >::getMaxZone ( ) const

inline

Returns the largest zone id in the index.

Definition at line 240 of file ZoneTypes.h.

{ return _maxZone; }

template<typename EntryT>

int lsst::ap::ZoneIndex< EntryT >::getMinZone ( ) const

inline

Returns the smallest zone id in the index.

Definition at line 237 of file ZoneTypes.h.

{ return _minZone; }

template<typename EntryT>

Zone* lsst::ap::ZoneIndex< EntryT >::getZone ( int const  zone )

inline

Returns a pointer to the zone with the given id, or 0 if the requested zone isn't in the index.

Definition at line 246 of file ZoneTypes.h.

                                   {
        if (zone >= _minZone && zone <= _maxZone) {
            return &_zones[zone - _minZone];
        }
        return 0;
    }

template<typename EntryT>

void lsst::ap::ZoneIndex< EntryT >::insert ( double const  ra, double const  dec, Data *const  data, Chunk *const  chunk, int const  index  )

inline

Inserts the given data item from the given chunk into the index.

Definition at line 229 of file ZoneTypes.h.

                                                                                                            {
        int const zone = _zsc.decToZone(data->getDec());
        if (zone >= _minZone && zone <= _maxZone) {
            _zones[zone - _minZone].insert(ra, dec, data, chunk, index);
        }
    }

template<typename EntryT >

template<typename FilterT >

int lsst::ap::ZoneIndex< EntryT >::pack

(

FilterT &

filter

)

Given a functor that implements

bool operator()(EntryT const &) 

, removes any entry e where filter(e) returns false from the index.

Returns

the number of entries that were removed.

Definition at line 299 of file ZoneTypes.cc.

                                                  {
    int const numZones = _maxZone - _minZone + 1;
    int numPacked = 0;
#if LSST_AP_HAVE_OPEN_MP
#   pragma omp parallel for default(shared) \
               reduction(+:numPacked) \
               schedule(static,8)
#endif
    for (int z = 0; z < numZones; ++z) {
        int np = _zones[z].pack<FilterT>(filter);
        numPacked = numPacked + np;
    } // end of parallel for
    return numPacked;
}

template<typename EntryT >

void lsst::ap::ZoneIndex< EntryT >::setDecBounds	(	double const	minDec,
		double const	maxDec
	)

Sets the range of declination values the index will accept data for.

Definition at line 225 of file ZoneTypes.cc.

                                                                                   {
    int minZone = _zsc.decToZone(minDec);
    int maxZone = _zsc.decToZone(maxDec);
    if (maxZone < minZone) {
        throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                          "min/max zone ids inverted");
    }
    int const cap = maxZone - minZone + 1;
    if (cap >= _capacity) {
        int const worst = _zsc.getMaxEntriesPerZoneEstimate();
        boost::scoped_array<Zone> zones(new Zone[cap]);
        int i = 0;
        for ( ; i < _capacity; ++i) {
            zones[i] = _zones[i];
        }
        for ( ; i < cap; ++i) {
            zones[i].init(worst);
        }
        // transfer zone ownership from old zone array to new array
        for (i = 0; i < _capacity; ++i) {
            _zones[i]._entries  = 0;
            _zones[i]._size     = 0;
            _zones[i]._capacity = 0;
        }
        using std::swap;
        swap(_zones, zones);
        _capacity = cap;
    }

    int i = 0;
    for ( ; i <= maxZone - minZone; ++i) {
        _zones[i].clear();
        _zones[i]._zone = i + minZone;
    }
    for ( ; i < _capacity; ++i) {
        _zones[i].clear();
    }
    _minZone = minZone;
    _maxZone = maxZone;
}

template<typename EntryT >

int lsst::ap::ZoneIndex< EntryT >::size

(

)

const

Returns the number of entries in the index.

Definition at line 214 of file ZoneTypes.cc.

                                        {
    int sz = 0;
    for (int i = 0; i <= _maxZone - _minZone; ++i) {
        sz += _zones[i].size();
    }
    return sz;
}

template<typename EntryT >

void lsst::ap::ZoneIndex< EntryT >::sort

(

)

Sorts each zone in the index (on right ascension)

Definition at line 279 of file ZoneTypes.cc.

                                   {
    int const numZones = _maxZone - _minZone + 1;
#if LSST_AP_HAVE_OPEN_MP
#   pragma omp parallel for default(shared) \
               schedule(static,8)
#endif
    for (int t = 0; t < numZones; ++t) {
        _zones[t].sort();
    } // end of parallel for
}

Member Data Documentation

template<typename EntryT>

int lsst::ap::ZoneIndex< EntryT >::_capacity

private

Definition at line 289 of file ZoneTypes.h.

template<typename EntryT>

int lsst::ap::ZoneIndex< EntryT >::_maxZone

private

Definition at line 291 of file ZoneTypes.h.

template<typename EntryT>

int lsst::ap::ZoneIndex< EntryT >::_minZone

private

Definition at line 290 of file ZoneTypes.h.

template<typename EntryT>

boost::scoped_array<Zone> lsst::ap::ZoneIndex< EntryT >::_zones

private

Definition at line 288 of file ZoneTypes.h.

template<typename EntryT>

ZoneStripeChunkDecomposition lsst::ap::ZoneIndex< EntryT >::_zsc

private

Definition at line 287 of file ZoneTypes.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/ZoneTypes.h
• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/ZoneTypes.cc