Skip to content

shapeworks::IndexRegion

Indices into a 3d region of memory (can be negative, e.g., for the purpose of padding an image)

#include <Region.h>

Public Functions

Name
IndexRegion() =default
IndexRegion(const IndexRegion & ) =default
IndexRegion(const Dims & dims)
IndexRegion(const Coord & _min, const Coord & _max)
bool operator==(const IndexRegion & other) const
bool valid() const
verified min/max do not create an inverted or an empty region
Coord origin() const
Dims size() const
IndexRegion & pad(int padding)
uniformly grows or shrinks the region by the specified amount

Public Attributes

Name
Coord min
Coord max

Public Functions Documentation

function IndexRegion

cpp IndexRegion() =default

function IndexRegion

cpp IndexRegion( const IndexRegion & ) =default

function IndexRegion

cpp inline IndexRegion( const Dims & dims )

function IndexRegion

cpp inline IndexRegion( const Coord & _min, const Coord & _max )

function operator==

cpp inline bool operator==( const IndexRegion & other ) const

function valid

cpp inline bool valid() const

verified min/max do not create an inverted or an empty region

function origin

cpp inline Coord origin() const

function size

cpp inline Dims size() const

function pad

cpp IndexRegion & pad( int padding )

uniformly grows or shrinks the region by the specified amount

Public Attributes Documentation

variable min

cpp Coord min {1000000000, 1000000000, 1000000000};

variable max

cpp Coord max {-1000000000, -1000000000, -1000000000};


Updated on 2026-03-31 at 16:02:10 +0000