Accept or reject DcmItem objects by comparing a specific attribute to a set of values.
More...
|
struct | FilterInterface |
| all actual filter implementations must inherit this interface. More...
|
|
class | IteratorBasedFilter |
| A range-based filter implementation that compares an attribute's value with a range of values defined by two iterators. More...
|
|
Accept or reject DcmItem objects by comparing a specific attribute to a set of values.
DcmAttributeFilter objects can be used to compare a specific attribute with one or more values - or to accept any DcmItem if no attribute is specified. DcmAttributeFilter objects can be used like any function taking a DcmItem& or a DcmFileFormat& object as parameter and returning a boolean value.
template<typename Iterator >
DcmAttributeFilter::DcmAttributeFilter |
( |
const DcmTagKey & |
tag, |
|
|
const Iterator & |
begin, |
|
|
const Iterator & |
end |
|
) |
| |
|
inline |
construct a DcmAttributeFilter object from two iterators defining the range of values.
- Note
- each value should be comparable with an object of type OFString.
- Template Parameters
-
Iterator | a type matching the STL's ForwardIterator concept. |
- Parameters
-
tag | a DcmTagKey object determining which attribute of a DcmItem should be compared with the range of values. |
begin | an iterator referring to the first element in the range of values. |
end | an iterator referring to one past the end in the range of values. |
template<typename Container >
DcmAttributeFilter::DcmAttributeFilter |
( |
const DcmTagKey & |
tag, |
|
|
const Container & |
container |
|
) |
| |
|
inline |
construct a DcmAttributeFilter object from a container containing the range of values.
- Note
- each value should be comparable with an object of type OFString.
- Template Parameters
-
Container | a class matching the STL's Container concept. |
- Parameters
-
tag | a DcmTagKey object determining which attribute of a DcmItem should be compared with the range of values. |
container | a container containing the range of values. |
DcmAttributeFilter::DcmAttributeFilter |
( |
const DcmTagKey & |
tag, |
|
|
const OFString & |
value |
|
) |
| |
construct a DcmAttributeFilter object that compares the attribute with one specific value.
- Parameters
-
tag | a DcmTagKey object determining which attribute of a DcmItem should be compared with the value. |
value | an OFString that is to be compared with the actual value stored in the DcmItem the filter is invoked on. |
DcmAttributeFilter::DcmAttributeFilter |
( |
const DcmTagKey & |
tag, |
|
|
const char *const |
value |
|
) |
| |
construct a DcmAttributeFilter object that compares the attribute with one specific value.
- Parameters
-
tag | a DcmTagKey object determining which attribute of a DcmItem should be compared with the value. |
value | a character string that is to be compared with the actual value stored in the DcmItem the filter is invoked on. |
apply the filter on a DcmItem.
- Parameters
-
item | a DcmItem the filter should accept or reject. |
- Returns
- OFTrue if the filter accepts the item, OFFalse otherwise.
apply the filter on a DICOM file (represented by a DcmFileFormat instance).
- Parameters
-
dcmfile | a DcmFileFormat object the filter should accept or reject. |
- Returns
- OFTrue if the filter accepts the DICOM file, OFFalse otherwise.
template<typename Iterator >
static IteratorBasedFilter<Iterator>* DcmAttributeFilter::createIteratorBasedFilter |
( |
const Iterator & |
begin, |
|
|
const Iterator & |
end |
|
) |
| |
|
inlinestaticprivate |
helper function to deduce the Iterator type from a container's begin() and end() method.
- Template Parameters
-
Iterator | a type matching the STL's ForwardIterator concept. |
- Parameters
-
begin | an iterator referring to the first element in the range of values. |
end | an iterator referring to one past the end in the range of values. |
- Returns
- a pointer to a newly created IteratorBasedFilter object.
convenience function to enable using DcmAttributeFilter as a functor.
- Parameters
-
item | a DcmItem the filter should accept or reject. |
- Returns
- OFTrue if the filter accepts the item, OFFalse otherwise.
convenience function to enable using DcmAttributeFilter as a functor.
- Parameters
-
dcmfile | a DcmFileFormat object the filter should accept or reject. |
- Returns
- OFTrue if the filter accepts the DICOM file, OFFalse otherwise.
The documentation for this class was generated from the following file:
- dcmdata/include/dcmtk/dcmdata/dcfilter.h