Package org.dcm4che.typeddicom.dataelements

Class FilterByOperator

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FilterByOperator

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class FilterByOperator
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Filter-by Operator
Keyword: FilterByOperator
Tag: (0072,0406)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Hanging Protocol Display Module > Display Sets Sequence > Filter Operations Sequence > Filter-by Operator
  as follows:
  Attribute Name: Filter-by Operator
  Type: 1C
  Attribute Description:

  Operation to be applied between the value(s) in the Hanging Protocol Selector Attribute Value Macro ("selector"), and the value(s) of the Attribute identified by Selector Attribute (0072,0026) (or the value implied by the Filter-by Category (0072,0402)) in each image of the Image Set. See DICOM Standard Part 3 - Section C.23.3.1.1.

  Required if Filter-by Category (0072,0402) is present, or if Selector Attribute (0072,0026) is present and Filter-by Attribute Presence (0072,0404) is not present.

  Enumerated Values:

  RANGE_INCL

  all values lie within the specified range, or are equal to the endpoints; applies only to numeric Selector Attribute (0072,0026) values; two values shall be present in the selector, the first of which is less than or equal to the second

  RANGE_EXCL

  all values lie outside the specified range, and are not equal to the endpoints; applies only to numeric Selector Attribute (0072,0026) values; two values shall be present in the selector, the first of which is less than or equal to the second

  GREATER_OR_EQUAL

  all values are greater than or equal to the value of the selector; applies only to numeric Selector Attribute (0072,0026)

  LESS_OR_EQUAL

  all values are less than or equal to the value of the selector; applies only to numeric Selector Attribute (0072,0026)

  GREATER_THAN

  all values are greater than the value of the selector; applies only to numeric Selector Attribute (0072,0026)

  LESS_THAN

  all values are less than the value of the selector; applies only to numeric Selector Attribute (0072,0026)

  MEMBER_OF

  one of the values in the image is present in the values of the selector; if one value is present in each, this is an "equal to" operator

  NOT_MEMBER_OF

  none of the values in the image is present in the values of the selector; if one value is present in each, this is a "not equal to" operator

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilterByOperator.Builder<SELF extends FilterByOperator.Builder<SELF,T>,T extends FilterByOperator.Holder>
static interface	FilterByOperator.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Filter-by Operator" (see FilterByOperator)

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
FilterByOperator()	Creates a new Filter-by Operator object which wraps a new and empty Attributes object.
FilterByOperator(org.dcm4che3.data.Attributes attributes)	Creates a new Filter-by Operator object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
FilterByOperator	copy()	Returns a new Filter-by Operator which wraps a copy of the Attributes wrapped in this Filter-by Operator.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

FilterByOperator

public FilterByOperator(org.dcm4che3.data.Attributes attributes)

Creates a new Filter-by Operator object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FilterByOperator

public FilterByOperator()

Creates a new Filter-by Operator object which wraps a new and empty Attributes object.

Method Details

copy

public FilterByOperator copy()

Returns a new Filter-by Operator which wraps a copy of the Attributes wrapped in this Filter-by Operator. (see Attributes(Attributes)

Returns:

a new Filter-by Operator which wraps a copy of the Attributes wrapped in this Filter-by Operator.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.