ICAROUS
All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Modules Pages
Static Public Member Functions | List of all members
larcfm::DetectionPolygonParameterWriter Class Reference

#include <DetectionPolygonParameterWriter.h>

Static Public Member Functions

static ParameterData writePolygonDetection (std::vector< DetectionPolygon * > dlist, DetectionPolygon *det, DetectionPolygon *res)
 
static ParameterData writePolygonDetection (std::vector< DetectionPolygon * > dlist, DetectionPolygon *det, DetectionPolygon *res, bool ordered)
 

Detailed Description

This class contains static methods to create ParameterData objects that contain information about DetectionPolygon instance definitions in a format consistent with DetectionPolygonParameterReader.

Member Function Documentation

◆ writePolygonDetection() [1/2]

ParameterData larcfm::DetectionPolygonParameterWriter::writePolygonDetection ( std::vector< DetectionPolygon * >  dlist,
DetectionPolygon det,
DetectionPolygon res 
)
static

Return a ParameterData suitable to be read by readPolygonDetection() based on the supplied DetectionPolygon instances.

Parameters
dlistlist of DetectionPolygon instances – this may be empty. det and res instances will be automatically added to the list (if they are not already in it)
detdetection instance – this may be null
resresolution instance – this may be null Note: this may modify the instance identifiers if they are not already unique.

◆ writePolygonDetection() [2/2]

ParameterData larcfm::DetectionPolygonParameterWriter::writePolygonDetection ( std::vector< DetectionPolygon * >  dlist,
DetectionPolygon det,
DetectionPolygon res,
bool  ordered 
)
static

Return a ParameterData suitable to be read by readPolygonDetection() based on the supplied DetectionPolygon instances.

Parameters
dlistlist of DetectionPolygon instances – this may be empty. det and res instances will be automatically added to the list (if they are not already in it)
detdetection instance – this may be null
resresolution instance – this may be null
orderedtrue to modify detection identifiers to ensure they retain the input list's ordering when decoded, false will only modify identifiers if they are not unique

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