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

IndexRegion() =default

function IndexRegion

IndexRegion(
    const IndexRegion & 
) =default

function IndexRegion

inline IndexRegion(
    const Dims & dims
)

function IndexRegion

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

function operator==

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

function valid

inline bool valid() const

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

function origin

inline Coord origin() const

function size

inline Dims size() const

function pad

IndexRegion & pad(
    int padding
)

uniformly grows or shrinks the region by the specified amount

Public Attributes Documentation

variable min

Coord min {1000000000, 1000000000, 1000000000};

variable max

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

Updated on 2024-07-12 at 20:10:34 +0000