lsst::jointcal::FittedStarList Class Reference

A list of FittedStar s. Such a list is typically constructed by Associations. More...

#include <FittedStar.h>

Inheritance diagram for lsst::jointcal::FittedStarList:

Public Types
using	Element
using	StarCIterator
using	StarIterator

Public Member Functions
	FittedStarList ()
void	print (std::ostream &out) const
	invokes print(stream) for all Stars in the std::list.
void	fluxSort ()
	a model routine to sort the std::list
void	cutTail (int nKeep)
	cuts the end of the std::list
void	extractInFrame (StarList< FittedStar > &out, const Frame &frame) const
	copy the part of the std::list which is included in the frame at the end of another std::list
void	copyTo (StarList< FittedStar > &copy) const
	clears copy and makes a copy of the std::list to copy
void	clearList ()
	Clears the std::list.
void	applyTransform (const Operator &op)
	enables to apply a geometrical transform if Star is Basestar or derives from it.
std::shared_ptr< FittedStar >	pop_front (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	push_back (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	splice (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	crbegin (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	erase (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	emplace_front (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	insert (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	reverse (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	back (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	end (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	remove (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	emplace_back (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	pop_back (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	cbegin (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	front (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	unique (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	size (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	resize (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	push_front (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	rbegin (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	crend (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	assign (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	sort (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	merge (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	empty (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	remove_if (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	cend (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	swap (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	max_size (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	rend (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	get_allocator (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	clear (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	emplace (std::shared_ptr< FittedStar >... args)
std::shared_ptr< FittedStar >	begin (std::shared_ptr< FittedStar >... args)

Public Attributes
bool	inTangentPlaneCoordinates
std::shared_ptr< FittedStar >	elements
	STL member.

Detailed Description

A list of FittedStar s. Such a list is typically constructed by Associations.

Definition at line 116 of file FittedStar.h.

Member Typedef Documentation

Element

using lsst::jointcal::StarList< FittedStar >::Element

inherited

Definition at line 60 of file StarList.h.

StarCIterator

using lsst::jointcal::StarList< FittedStar >::StarCIterator

inherited

Definition at line 61 of file StarList.h.

StarIterator

using lsst::jointcal::StarList< FittedStar >::StarIterator

inherited

Definition at line 62 of file StarList.h.

Constructor & Destructor Documentation

FittedStarList()

lsst::jointcal::FittedStarList::FittedStarList ( )

inline

Definition at line 121 of file FittedStar.h.

{ inTangentPlaneCoordinates = true; }

Member Function Documentation

applyTransform()

void lsst::jointcal::StarList< FittedStar >::applyTransform ( const Operator & op )

inlineinherited

enables to apply a geometrical transform if Star is Basestar or derives from it.

could be extended to other type of transformations.

Definition at line 98 of file StarList.h.

                                            {
        for (auto &p : *this) op.transformStar(*(p));
    }

clearList()

void lsst::jointcal::StarList< FittedStar >::clearList ( )

inlineinherited

Clears the std::list.

Definition at line 92 of file StarList.h.

{ cutTail(0); };

copyTo()

void lsst::jointcal::StarList< FittedStar >::copyTo ( StarList< FittedStar > & copy ) const

inherited

clears copy and makes a copy of the std::list to copy

Definition at line 89 of file StarList.cc.

                                                      {
    copy.clearList();
    for (auto const &si : *this) copy.push_back(std::make_shared<Star>(*si));
}

cutTail()

void lsst::jointcal::StarList< FittedStar >::cutTail ( int nKeep )

inherited

cuts the end of the std::list

Definition at line 83 of file StarList.cc.

                                            {
    int count = 0;
    auto si = this->begin();
    for (; si != this->end() && count < nKeep; ++count, ++si)
        ;
    while (si != this->end()) {
        si = this->erase(si);
    }
}

extractInFrame()

void lsst::jointcal::StarList< FittedStar >::extractInFrame ( StarList< FittedStar > & out, const Frame & frame ) const

inherited

copy the part of the std::list which is included in the frame at the end of another std::list

Definition at line 86 of file StarList.cc.

                                                                                 {
    for (auto const &star : *this) {
        if (frame.inFrame(*star)) {
            out.push_back(std::make_shared<Star>(*star));
        }
    }
}

fluxSort()

void lsst::jointcal::StarList< FittedStar >::fluxSort ( )

inherited

a model routine to sort the std::list

see decreasingFlux() to see what it is, if you want another sorting criterion)

Definition at line 80 of file StarList.cc.

                              {
    using E = StarList<Star>::Element;
    this->sort([](const E &e1, const E &e2) { return (e1->getFlux() > e2->getFlux()); });
}

print()

void lsst::jointcal::StarList< FittedStar >::print ( std::ostream & out ) const

inlineinherited

invokes print(stream) for all Stars in the std::list.

Definition at line 72 of file StarList.h.

                                      {
        for (auto &p : *this) p->print(out);
    }

Member Data Documentation

elements

std::shared_ptr< FittedStar > std::list< std::shared_ptr< FittedStar > >::elements

inherited

STL member.

inTangentPlaneCoordinates

bool lsst::jointcal::FittedStarList::inTangentPlaneCoordinates

Definition at line 118 of file FittedStar.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/jointcal/g29ae962dfc+1c7d47a24f/include/lsst/jointcal/FittedStar.h