Pulsar::ScrunchFactor Class Reference

Manages a combined scrunch factor or target dimension. More...

#include <ScrunchFactor.h>

Public Member Functions

 ScrunchFactor (unsigned nresult=1)
 Default constructor.
 
unsigned get_nresult () const
 Get the number of elements to scrunch to.
 
void set_nresult (unsigned value)
 Set the number of elements to scrunch to.
 
unsigned get_nscrunch () const
 Get the number of elements to be integrated.
 
void set_nscrunch (unsigned value)
 Set the number of elements to be integrated.
 
bool scrunch_enabled () const
 Return true if scrunch should be performed.
 
void disable_scrunch ()
 Disable scrunching.
 
unsigned get_nresult (unsigned size) const
 Return the number of elements after scrunch.
 
unsigned get_nscrunch (unsigned size) const
 Return the number of elements to be integrated.
 

Static Public Attributes

static const ScrunchFactor none
 Useful for passing default = disabled.
 

Detailed Description

Manages a combined scrunch factor or target dimension.


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

Generated using doxygen 1.8.17