Package org.dcm4che.typeddicom.dataelements

Class KVP

  • All Implemented Interfaces:
    org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, DecimalStringWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper
    public class KVP
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements DecimalStringWrapper
    Name: KVP
    Keyword: KVP
    Tag: (0018,0060)
    Value Representation: DecimalString
    Value Multiplicity: 1
    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1C
      Attribute Description:

      Exact peak kilo voltage output of the X-Ray generator used for this projection.

      Required if present and consistent in the contributing SOP Instances. Required if Modality (0008,0060) is MG.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 3
      Attribute Description:

      Peak kilo voltage output of the x-ray generator.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1C
      Attribute Description:

      Peak kilo voltage output of the setup X-Ray generator used. Required for Control Point 0 of Ion Control Point Delivery Sequence (3008,0041), or if kVp changes during setup, and Nominal Beam Energy (300A,0114) is not present.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 2C
      Attribute Description:

      Peak kilo voltage of the X-Ray generator used to acquire the image.

      Required if Imaging Energy Derivation Code Sequence (3002,0133) is not present.

      See DICOM Standard Part 3 - Section C.36.2.4.6.1.1.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1C
      Attribute Description:

      Average of the peak kilo voltage outputs of the X-Ray generator used for all frames.

      Required if present and consistent in the contributing SOP Instances. Required if Modality (0008,0060) is MG.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1
      Attribute Description:

      Peak kilo voltage output of the X-Ray generator.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1
      Attribute Description:

      Average of the peak kilo voltage outputs of the X-Ray generator used for all frames.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 2
      Attribute Description:

      Peak kilo voltage output of the X-Ray generator used.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 3
      Attribute Description:

      Peak kilo voltage output of the X-Ray generator used.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1C
      Attribute Description:

      Peak kilo voltage output of the setup X-Ray generator to be used. Required for first Item of Control Point Sequence, or if kVp changes during setup, and Nominal Beam Energy (300A,0114) is not present.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1
      Attribute Description:

      Peak kilo voltage output of the X-Ray generator used.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 1C
      Attribute Description:

      Nominal peak kilo voltage output of the X-Ray generator used.

      If Multi-energy Source Technique (0018,9368) in Multi-energy CT X-Ray Source Sequence (0018,9365) (of the referenced Multi-energy CT Path Index (0018,937A)) is "SWITCHING_SOURCE", this value is the nominal peak value for a switching phase. The switching phase is identified by the value of X-Ray Source Index (0018,9366) in the Multi-energy CT Path Sequence (0018,9379) corresponding to the value of Referenced Path Index (0018,9378) in this Sequence.

      Due to limitations of the generating hardware the actual voltage may not reach the nominal peak value.

      Required if Frame Type (0008,9007) Value 1 of this frame is ORIGINAL or Image Type (0008,0008) Value 1 is ORIGINAL. May be present otherwise.


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 2
      Attribute Description:

      Peak kilo voltage output of the X-Ray generator used.

      Shall be empty if this Attribute is present in Multi-energy CT Acquisition Sequence (0018,9362).


    • Described in the contexts: as follows:
      Attribute Name: KVP
      Type: 2C
      Attribute Description:

      Peak kilo voltage output (kV) of X-Ray generator used to acquire image. Required if Value 3 of Image Type (0008,0008) is PORTAL, SIMULATOR or RADIOGRAPH.


    • Constructor Summary

      Constructors 
      Constructor Description
      KVP()
      Creates a new KVP object which wraps a new and empty Attributes object.
      KVP​(org.dcm4che3.data.Attributes attributes)
      Creates a new KVP object which wraps the provided attributes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      KVP copy()
      Returns a new KVP which wraps a copy of the Attributes wrapped in this KVP.
      java.lang.String getPrivateCreator()  
      int getTag()  

      • 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, getKnownAttributeTags, getUnknownAttributeTags, 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.DoubleDataElementWrapper

        getDouble, setDouble

      • Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper

        getFloat, setFloat

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

        getString, setString

    • Constructor Detail

      • KVP

        public KVP​(org.dcm4che3.data.Attributes attributes)
        Creates a new KVP object which wraps the provided attributes.
        Parameters:
        attributes - the Attributes object to be wrapped.

      • KVP

        public KVP()
        Creates a new KVP object which wraps a new and empty Attributes object.

    • Method Detail

      • copy

        public KVP copy()
        Returns a new KVP which wraps a copy of the Attributes wrapped in this KVP. (see Attributes(Attributes)
        Returns:
        a new KVP which wraps a copy of the Attributes wrapped in this KVP.

      • getPrivateCreator

        public java.lang.String getPrivateCreator()
        Specified by:
        getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

      • getTag

        public int getTag()
        Specified by:
        getTag in interface org.dcm4che.typeddicom.DataElementWrapper