Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation to Footprints #229

Merged
merged 1 commit into from
May 16, 2017
Merged

Add documentation to Footprints #229

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 20 additions & 3 deletions include/lsst/afw/detection/Footprint.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,28 @@ class Footprint : public lsst::daf::base::Citizen,
* that to construct the Footprint.
*/

explicit Footprint(std::shared_ptr<geom::SpanSet> inputSpans, geom::Box2I const &region = geom::Box2I());
/** @brief Constructor for Footprint object
*
* @param inputSpans Shared pointer to a SpanSet defining the pixels included in
the Footprint.
* @param region Bounding box of the image in which the Footprint was created,
defaults to empty box.
*/
explicit Footprint(std::shared_ptr<geom::SpanSet> inputSpans, geom::Box2I const & region=geom::Box2I());

explicit Footprint(std::shared_ptr<geom::SpanSet> inputSpans, afw::table::Schema const &peakSchema,
geom::Box2I const &region = geom::Box2I());
/** @brief Constructor for the Footprint object
*
* @param inputSpans Shared pointer to a SpanSet defining the pixels included in
the Footprint.
* @param peakSchema schema to be used in the PeakCatalog
* @param region Bounding box of the image in which the Footprint was created,
defaults to empty box.
*/
explicit Footprint(std::shared_ptr<geom::SpanSet> inputSpans, afw::table::Schema const & peakSchema,
geom::Box2I const & region=geom::Box2I());

/** @brief Constructor of a empty Footprint object
*/
explicit Footprint()
: lsst::daf::base::Citizen(typeid(this)),
_spans(std::make_shared<geom::SpanSet>()),
Expand Down