Package org.dcm4che.typeddicom.valuerepresentations

Interface CodeStringWrapper

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

All Known Implementing Classes:

AbortFlag, AbsoluteDosimetricObjectiveFlag, AcquiredSubtractionMaskFlag, AcquisitionCompressionType, AcquisitionContrast, AcquisitionMotion, AcquisitionStartCondition, AcquisitionStatus, AcquisitionTerminationCondition, AcquisitionTimeSynchronized, AcquisitionType, AdditionalInspectionSelectionCriteria, AdditionalScreeningPerformed, AITDeviceType, AlarmDecision, AlgorithmType, AliasedDataType, AllowLossyCompression, AllowMediaSplitting, AlphaLUTTransferFunction, AlternateBeamDoseType, AmbientLightValueSource, AmplifierType, AnatomicalOrientationType, AnatomicStructure, AnchorPointAnnotationUnits, AnchorPointVisibility, AngioFlag, AnnotationAppliesToAllOpticalPaths, AnnotationAppliesToAllZPlanes, AnnotationClipping, AnnotationCoordinateType, AnnotationDisplayFormatID, AnnotationFlag, AnnotationGroupGenerationType, AnodeTargetMaterial, ApplicableSafetyStandardAgency, ApplicationSetupCheck, ApplicationSetupType, ApplicatorApertureShape, ApplicatorType, AppliedMaskSubtractionFlag, ApprovalStatus, ArchiveRequested, ArterialSpinLabelingContrast, ASLBolusCutoffFlag, ASLContext, ASLCrusherFlag, AssessmentSummary, ATDAbilityAssessment, ATDAssessmentFlag, AttenuationCorrected, AttenuationCorrectionSource, AttenuationCorrectionTemporalRelationship, AutoKVPSelectionType, AutosequenceFlag, BackgroundColor, BarcodeSymbology, BaselineCorrection, BeamDoseMeaning, BeamDoseType, BeamHoldTransition, BeamLimitingDeviceRotationDirection, BeamStopperPosition, BeamTaskType, BeamType, BeatRejectionFlag, BlendingLUT1TransferFunction, BlendingLUT2TransferFunction, BlendingMode, BlendingOperationType, BlendingPosition, BlindSpotLocalized, BlockDivergence, BlockedPixels, BlockIdentifyingInformationStatus, BlockMountingPosition, BlockOrientation, BlockType, BloodSignalNulling, BodyPartExamined, Bold, BorderDensity, BoundingBoxAnnotationUnits, BoundingBoxTextHorizontalJustification, BrachyAccessoryDeviceType, BrachyTreatmentTechnique, BrachyTreatmentType, BreastImplantPresent, BulkMotionCompensationTechnique, BulkMotionSignalSource, BulkMotionStatus, BurnedInAnnotation, CalculationCommentType, CalibrationImage, CardiacBeatRejectionTechnique, CardiacCyclePosition, CardiacSignalSource, CardiacSynchronizationTechnique, CArmPositionerTabletopRelationship, CarrierIDAssigningAuthority, CassetteOrientation, CassetteSize, CatchTrialsDataFlag, CatheterDirectionOfRotation, CertificateType, CertifiedTimestampType, ChannelMode, CodingSchemeURLType, CollationFlag, CollimatorType, ColorImagePrintingFlag, ColorSpace, CompensatorDivergence, CompensatorMapOrientation, CompensatorMountingPosition, CompensatorType, CompletionFlag, ComplexImageComponent, ComponentShape, ComponentType, CompositingMethod, CompoundGraphicType, CompoundGraphicUnits, CompressionCode, ConceptualVolumeBlockingConstraint, ConceptualVolumeCombinationFlag, ConceptualVolumeSegmentationDefinedFlag, ConnectorType, ConsentForDistributionFlag, ConstantVolumeFlag, ConstraintType, ConstraintViolationSignificance, ContactMethod, ContainerComponentMaterial, ContainerFileType, ContentLabel, ContentQualification, ContextGroupExtensionFlag, ContextIdentifier, ContinuityOfContent, ContourGeometricType, ContrastBolusAgentAdministered, ContrastBolusAgentDetected, ContrastBolusAgentPhase, ContrastBolusAutoInjectionTriggerFlag, ContrastBolusIngredient, ContrastBolusIngredientOpaque, ConversionType, ConvolutionKernelGroup, CoordinatesSetGeometricTypeTrial, CoordinateSystemAxisType, CoordinateSystemAxisUnits, CoordinateSystemDataSetMapping, CornealPointEstimated, CornealTopographyMapQualityEvaluation, CornealTopographySurface, CorrectedLocalizedDeviationFromNormalCalculated, CorrectedLocalizedDeviationFromNormalProbabilityCalculated, CountLossNormalizationCorrected, CountsSource, CoverageOfKSpace, Crop, CurrentTreatmentStatus, CurvatureType, CurveActivationLayer, DACType, DataElementConditionality, DataPathAssignment, DataPathID, DataRepresentation, DataType, DeadTimeCorrected, DeadTimeCorrectionFlag, DecayCorrected, DecayCorrection, DecimateCropResult, DecompositionMethod, Decoupling, DecouplingMethod, DefaultMagnificationType, DefaultPrinterResolutionID, DefaultSmoothingType, DegreeOfFreedomType, DeidentificationAction, DeliveredReferenceDoseDefinition, DepthValueAveragingFlag, DetectorActiveShape, DetectorConditionsNominalFlag, DetectorConfiguration, DetectorGeometry, DetectorNormalizationCorrection, DetectorType, DeviceAlternateIdentifierType, DeviceDiameterUnits, DeviceMotionExecutionMode, DeviceMotionObservationMode, DICOSVersion, DiffusionAnisotropyType, DiffusionDirectionality, DigitizingDeviceTransportDirection, DimensionOrganizationType, DirectoryRecordType, DisplayFunctionType, DisplaySetHorizontalJustification, DisplaySetVerticalJustification, DisplayShadingFlag, DistributionType, DoseCalibrationConditionsVerifiedFlag, DoseReferenceStructureType, DoseReferenceType, DoseSummationType, DoseType, DoseUnits, DosimetricObjectiveEvaluationScope, DosimetricObjectivePurpose, DoubleExposureFlag, DoubleExposureOrdering, DriveType, DVHROIContributionType, DVHType, DVHVolumeUnits, EchoPlanarPulseSequence, EchoPulseSequence, ElementShape, EmptyImageDensity, EndingRespiratoryPhase, EntranceDoseDerivation, EquipmentCoordinateSystemIdentification, EquipmentModality, ExcessiveFalseNegatives, ExcessiveFalseNegativesDataFlag, ExcessiveFalsePositives, ExcessiveFalsePositivesDataFlag, ExcessiveFixationLosses, ExcessiveFixationLossesDataFlag, ExclusiveComponentType, ExecutionStatus, ExecutionStatusInfo, ExposureControlMode, ExposureControlSensingRegionShape, ExposureStatus, ExtendedDepthOfField, FalseNegativesEstimateFlag, FalsePositivesEstimateFlag, FieldOfViewHorizontalFlip, FieldOfViewShape, FileSetID, FillMode, FilmDestination, FilmOrientation, FilmSizeID, FilterByAttributePresence, FilterByCategory, FilterByOperator, FindingsFlagTrial, FiniteVolume, FirstOrderPhaseCorrection, FixationDeviceType, FixationEye, FlowCompensation, FlowCompensationDirection, FluenceDataSource, FluenceMode, FluoroscopyFlag, FluoroscopyLastImageHoldPersistenceFlag, FluoroscopyPersistenceFlag, FocusMethod, FontNameType, FovealPointNormativeDataFlag, FovealSensitivityMeasured, FractionBasedRelationshipIntervalAnchor, FractionGroupType, FrameLaterality, FrameOfReferenceTransformationMatrixType, FrameOfReferenceTransformationType, FrequencyCorrection, FunctionalSettlingPhaseFramesPresent, GantryMotionCorrected, GantryPitchRotationDirection, GantryRotationDirection, GantryType, GeneralAccessoryType, GeneralizedDefectCorrectedSensitivityDeviationFlag, GeneralPurposePerformedProcedureStepStatus, GeneralPurposeScheduledProcedureStepPriority, GeneralPurposeScheduledProcedureStepStatus, GeometricalProperties, GeometryForDisplay, GeometryOfKSpaceTraversal, GlobalCrop, GlobalDeviationProbabilityNormalsFlag, GPSDestBearingRef, GPSDestDistanceRef, GPSDestLatitudeRef, GPSDestLongitudeRef, GPSImgDirectionRef, GPSLatitudeRef, GPSLongitudeRef, GPSMeasureMode, GPSSpeedRef, GPSStatus, GPSTrackRef, GradientOutputType, GraphicAnnotationUnits, GraphicFilled, GraphicLayer, GraphicType, GrayScale, HangingProtocolLevel, HighDoseTechniqueType, HighEnergyDetectors, HorizontalAlignment, HorizontalPrismBase, IdentifierTypeCode, ImageBoxLargeScrollType, ImageBoxLayoutType, ImageBoxPresentationLUTFlag, ImageBoxScrollDirection, ImageBoxSmallScrollType, ImageFormat, ImageHorizontalFlip, ImageLaterality, ImageOverlayFlag, ImageSetSelectorCategory, ImageSetSelectorUsageFlag, ImageVolumeGeometry, ImpedanceMeasurementCurrentType, ImplantAssemblyTemplateType, ImplantType, InboundArrivalType, IncludeDisplayApplication, IncludeNonDICOMObjects, IncludesImagingSubject, IncludesInformation, IndexNormalsFlag, IndicationDisposition, InitialCineRunState, InPlanePhaseEncodingDirection, InputAvailabilityFlag, InputReadinessState, InspectionSelectionCriteria, InstanceAvailability, InstanceOriginStatus, InstructionPerformedFlag, IntensifierActiveShape, InternationalRouteSegment, InteroperabilityIndex, InterpolationType, InterpretationStatusID, InterpretationTypeID, InterventionStatus, InventoryCompletionStatus, InventoryContentLevel, InversionRecovery, Italic, IterativeReconstructionMethod, IVUSAcquisition, KSpaceFiltering, LabelStyleSelection, LabelUsingInformationExtractedFromInstances, Laterality, LateralSpreadingDeviceType, LensSegmentType, LightSourcePolarization, LineDashingStyle, LocalDeviationProbabilityNormalsFlag, LongitudinalTemporalEventType, LongitudinalTemporalInformationModified, LossyImageCompression, LossyImageCompressionRetired, LowEnergyDetectors, LUTFunction, MACAlgorithm, MagnetizationTransfer, MagnificationType, MandatoryComponentType, Manifold, MappingResource, MaskOperation, MaskSelectionMode, MeasuredDoseType, MeasurementAutomationTrial, MeasurementEquipmentType, MeasurementLaterality, MediumType, Modality, ModelMirroring, ModelModification, ModifiableConstraintFlag, ModifiedImageID, ModifyingDeviceID, ModulatedScanModeType, ModulationType, MPRThicknessType, MRAcquisitionType, MRSpectroscopyAcquisitionType, MultiCoilElementUsed, MultienergyCTAcquisition, MultienergyDetectorType, MultienergySourceTechnique, MultiPlanarExcitation, MultiPlanarReconstructionStyle, MultipleCopiesFlag, MultipleSpinEcho, NominalBeamEnergyUnit, NonUniformRadialSamplingCorrected, NuclearMedicineSeriesType, ObservationSignificance, ObservationSubjectClassTrial, ObservationSubjectContextFlagTrial, ObserverContextFlagTrial, ObserverType, OCTAcquisitionDomain, OCTZOffsetApplied, OffsetDirection, OOIOwnerType, OOIType, OperatingMode, OperatingModeType, OphthalmicAxialLengthMeasurementModified, OphthalmicAxialLengthMeasurementsType, OphthalmicAxialLengthMethod, OphthalmicAxialMeasurementsDeviceType, OphthalmicImageOrientation, OphthalmicMappingDeviceType, OphthalmicVolumetricPropertiesFlag, Optotype, OptotypePresentation, OrganExposed, OutlineShapeType, OverlayActivationLayer, OverlayBackgroundDensity, OverlayCompressionCode, OverlayCompressionDescription, OverlayForegroundDensity, OverlayFormat, OverlayMagnificationType, OverlayMode, OverlayOrImageMagnification, OverlaySmoothingType, OverlayType, OversamplingPhase, ParallelAcquisition, ParallelAcquisitionTechnique, ParallelRTBeamDelimiterOpeningMode, PartialDataDisplayHandling, PartialFourier, PartialFourierDirection, PartialView, ParticipationType, PatientAlternativeCalendar, PatientEyeMovementCommanded, PatientFrameOfReferenceSource, PatientIdentityRemoved, PatientMotionCorrected, PatientPosition, PatientSex, PatientSexNeutered, PatientSupportPositionSpecificationMethod, PatientSupportRotationDirection, PatientSupportType, PerformedProcedureStepStatus, PerformedProtocolType, PhantomType, PhaseContrast, PhaseDescription, PhotometricInterpretation, PixelIntensityRelationship, PixelOriginInterpretation, PixelPresentation, PixelSpacingCalibrationType, PlaneIdentification, PlanesInAcquisition, PlanIntent, Polarity, PositionerMotion, PositionerPrimaryAngleDirection, PositionerType, PositionMeasuringDeviceUsed, PreliminaryFlag, PreSelectedForImplantation, PresentationAnimationStyle, PresentationInputType, PresentationIntentType, PresentationLUTFlag, PresentationLUTShape, PresentationSizeMode, PresentedVisualStimuliDataFlag, PreserveCompositeInstancesAfterMediaCreation, PrimaryDoseValueIndicator, PrimaryDosimeterUnit, PrinterResolutionID, PrinterStatus, PrinterStatusInfo, PrintPriority, PrivateDataElementValueRepresentation, ProcedureContextFlagTrial, ProcedureStepState, ProtocolDefinedPatientPosition, PseudoColorType, PulserType, PupilDilated, QuadratureReceiveCoil, QualityControlImage, QualityControlSubject, QueryRetrieveLevel, QueryRetrieveView, QueueStatus, RadiationMode, RadiationSetting, RadiationType, RadiobiologicalDoseEffectFlag, RadiotherapyTreatmentType, RandomsCorrected, RandomsCorrectionMethod, RangeModulatorType, RangeShifterType, RawDataHandling, ReasonForChannelOmission, ReasonForOmission, ReasonForTheAttributeModification, ReceiveCoilType, RecognizableVisualFeatures, RecommendedPresentationType, RecommendedViewingMode, ReconstructionAlgorithm, ReconstructionPipelineType, ReconstructionType, RectificationType, RectilinearPhaseEncodeReordering, ReferencedObjectObservationClassTrial, ReferencedObservationClassTrial, ReferenceDoseDefinition, ReferenceDoseType, ReformattingOperationInitialViewDirection, ReformattingOperationType, RefractiveIndexApplied, RefractiveProcedureOccurred, RegisteredLocalizerUnits, RelationshipType, RelativeTimeUnits, RemovedFromOperationalUse, RenderingMethod, RenderProjection, ReportedValuesOrigin, ReportProductionStatusTrial, ReprojectionMethod, RequestedDecimateCropBehavior, RequestedImageSizeFlag, RequestedResolutionID, RequestPriority, RespiratoryCyclePosition, RespiratoryMotionCompensationTechnique, RespiratorySignalSource, RespiratoryTriggerType, ResponsiblePersonRole, RetainInstances, RetestStimulusSeen, RGBLUTTransferFunction, RoboticBaseLocationIndicator, ROIGenerationAlgorithm, ROIPhysicalProperty, RotationDirection, RouteSegmentLocationIDType, RTAccessoryHolderSlotExistenceFlag, RTBeamLimitingDeviceType, RTImagePlane, RTPlanGeometry, RTPlanRelationship, RTRadiationPhysicalAndGeometricContentDetailFlag, RTRadiationSetDeliveryUsage, RTRadiationSetIntent, RTRadiationSetUsage, RTRadiationUsage, RTRecordFlag, RTROIInterpretedType, RTROIRelationship, RTTreatmentFractionCompletionStatus, RTTreatmentIntentType, RTTreatmentPhaseIntentPresenceFlag, RTTreatmentTerminationStatus, SaturationRecovery, ScanMode, ScanProgressionDirection, ScanSpotReordered, ScanSpotReorderingAllowed, ScanType, ScatterCorrected, ScheduledProcedureStepPriority, ScheduledProcedureStepStatus, SCPStatus, ScreeningBaselineMeasured, ScreeningBaselineType, SecondaryApprovalStatus, SegmentAlgorithmType, SegmentationFractionalType, SegmentationType, SegmentedKSpaceTraversal, SegmentsOverlap, SelectorAttributeVR, SensitivityCalibrated, SettlingPhaseFrame, SetupDeviceType, SetupTechnique, ShadingStyle, ShadowStyle, ShapeType, ShieldingDeviceType, ShortTermFluctuationCalculated, ShortTermFluctuationProbabilityCalculated, ShowAcquisitionTechniquesFlag, ShowGraphicAnnotationFlag, ShowGrayscaleInverted, ShowImageTrueSizeFlag, ShowPatientDemographicsFlag, ShowTickLabel, SignalDomainColumns, SignalDomainRows, SkipFrameRangeFlag, SliceProgressionDirection, SmokingStatus, SmoothingType, SOPInstanceStatus, SortByCategory, SortingDirection, SourceApplicatorType, SourceMovementType, SourceStrengthUnits, SourceType, SpatialLocationsPreserved, SpatialPresaturation, SpatialTransformOfDose, SpecificAbsorptionRateDefinition, SpecificCharacterSetOfFileSetDescriptorFile, SpecimenLabelInImage, SpectrallySelectedExcitation, SpectrallySelectedSuppression, Spoiling, StartingMetersetValueKnownFlag, StartingRespiratoryPhase, SteadyStatePulseSequence, StereoPairsPresent, StimulusResults, StudyComponentStatusID, StudyPriorityID, StudyStatusID, SubscriptionListStatus, SubstanceAdministrationApproval, SurfaceProcessing, SUVType, SynchronizationTrigger, SystemStatus, T2Preparation, TableMotion, TableTopEccentricRotationDirection, TableTopPitchRotationDirection, TableTopRollRotationDirection, TableType, Tagging, TDRType, TemplateExtensionFlag, TemplateIdentifier, TemporalRangeType, TemporalRelationshipIntervalAnchor, TestImageValidation, TestPointNormalsDataFlag, TestResult, TherapyDescription, TherapyType, ThreatCategory, ThresholdDensity, ThresholdType, TickAlignment, TickLabelAlignment, TimeDistributionProtocol, TimeOfFlightContrast, TimeOfFlightInformationUsed, TimeSeriesBlending, TIPType, TomoClass, TomoType, TransactionStatus, TransducerOrientation, TransducerPosition, TransducerType, TransformedAxisUnits, TransmitCoilType, TransportClassification, TreatmentDeliveryContinuationFlag, TreatmentDeliveryType, TreatmentRecordContentOrigin, TreatmentTerminationStatus, TreatmentToleranceViolationCategory, TreatmentVerificationStatus, Trim, TypeOfData, TypeOfDetectorMotion, TypeOfInstances, TypeOfOpticalCorrection, TypeOfPatientID, TypeOfSynchronization, UltrasoundAcquisitionGeometry, Underlined, UnifiedProcedureStepListStatus, Units, UniversalEntityIDType, ValueType, VariableFlipAngleFlag, VerificationFlag, VerificationImageTiming, VerticalAlignment, VerticalPrismBase, ViewingDistanceType, ViewPosition, VisitStatusID, VisualFieldShape, VisualFieldTestNormalsFlag, VOILUTFunction, VOIType, VolumeBasedCalculationTechnique, VolumeCroppingMethod, VolumeLocalizationTechnique, VolumeToTransducerRelationship, VolumetricProperties, WaterReferenceAcquisition, WaterReferencedPhaseCorrection, WaveformAmplifierType, WaveformFilterType, WaveformOriginality, WaveformSampleInterpretation, WedgeCurve, WedgeElement1Position, WedgePosition, WedgeType, WhitePointFlag, XRayReceptorType

public interface CodeStringWrapper
extends org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

Name: Code String
Tag: CS
Definition:

A string of characters identifying a controlled concept. Leading or trailing spaces (20H) are not significant.

Alternatively, in the context of a Query with Empty Value Matching (see PS3.4 PS3.4), a string of two QUOTATION MARK characters, representing an empty key Value.

Character Repertoire:

Uppercase characters, "0"-"9", the SPACE character, and underscore "_", of the Default Character Repertoire

In the context of a Query with Empty Value Matching (see PS3.4 PS3.4), the QUOTATION MARK character is allowed.

Length of Value:

16 bytes maximum

In the context of a Query with Empty Value Matching (see PS3.4 PS3.4), the length is 2 bytes fixed.

See Also:

DICOM Standard Part 5 - Code String

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CodeStringWrapper.Setter<B extends org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends CodeStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this interface.

Method Summary

Modifier and Type	Method	Description
default org.dcm4che3.data.VR	getValueRepresentation()

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, getPrivateCreator, getTag, getValue

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

getString, setString

Field Detail

VALUE_REPRESENTATION

static final org.dcm4che3.data.VR VALUE_REPRESENTATION

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

Method Detail

getValueRepresentation

default org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface org.dcm4che.typeddicom.DataElementWrapper