### DicomServer Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServer-1 Details the methods of the DicomServer class, including creating SCP instances, disposing the server, and starting the server asynchronously. ```APIDOC Methods: CreateScp(INetworkStream stream): T Create an instance of the DICOM service class. Parameters: stream: INetworkStream - Network stream. Returns: T - An instance of the DICOM service class. Dispose(): void Executes the disposal process. Dispose(bool disposing): void Execute the disposal. Parameters: disposing: System.Boolean - True if called from Dispose(), false otherwise. StartAsync(String ipAddress, Int32 port, ITlsAcceptor tlsAcceptor, Encoding encoding, DicomServiceOptions options, Object state, DicomServerOptions serverOptions): Task Starts the DICOM server listening for connections on the specified IP address(es) and port. ``` -------------------------------- ### DicomServer Class Syntax Example Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServer-1 Illustrates the C# syntax for declaring the DicomServer class, showing its inheritance and generic constraints. ```C# public class DicomServer : IDicomServer, IDicomServer, IDisposable where T : DicomService, IDicomServiceProvider ``` -------------------------------- ### DICOM Server Start and Stop Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServer-1 Documentation for starting and stopping a DICOM server. Includes parameters for network configuration, TLS handling, and service options. The Stop method halts server operations. ```APIDOC StartAsync Method: Signature: public virtual Task StartAsync(string ipAddress, int port, ITlsAcceptor tlsAcceptor, Encoding fallbackEncoding, DicomServiceOptions serviceOptions, object userState, DicomServerOptions serverOptions) Description: Starts the DICOM server to listen for incoming connections on the specified IP address and port. Parameters: - ipAddress (System.String): IP address(es) for the server to listen to. - port (System.Int32): Port to which the server should be listening. - tlsAcceptor (ITlsAcceptor): Handler to accept secure connections. - fallbackEncoding (System.Text.Encoding): Encoding to apply if no encoding is identified. - serviceOptions (DicomServiceOptions): Service options. - userState (System.Object): User state to be shared with the connected services. - serverOptions (DicomServerOptions): Server options. Returns: - System.Threading.Tasks.Task: Awaitable System.Threading.Tasks.Task. Stop Method: Signature: public virtual void Stop() Description: Stop server from further listening. Implements: - IDicomServer - IDicomServer - System.IDisposable Related Methods: - StartAsync ``` -------------------------------- ### DICOM Service Setup and Callbacks Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomService Methods for setting up long-running DICOM operations and handling callbacks when specific events occur, such as the send queue becoming empty. ```csharp APIDOC: RunAsync() - Sets up long-running operations that the DICOM service manages. - Returns: - Task: An awaitable task maintaining the long-running operation(s). OnSendQueueEmptyAsync() - Action to perform when the send queue is empty. - This is a protected virtual method, intended for extension. - Returns: - Task: A Task representing the asynchronous callback operation. ``` -------------------------------- ### DicomCStoreApplicationInfo Constructor Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCStoreApplicationInfo Initializes a new instance of the DicomCStoreApplicationInfo class using raw application information. ```C# public DicomCStoreApplicationInfo(byte[] rawApplicationInfo) ``` -------------------------------- ### Get DicomIconImage Width Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.DicomIconImage Gets the width of the icon image in pixels. This is a read-only property. ```C# public int Width { get; } ``` -------------------------------- ### Get DicomIconImage Height Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.DicomIconImage Gets the height of the icon image in pixels. This is a read-only property. ```C# public int Height { get; } ``` -------------------------------- ### DicomServerOptions Class Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServerOptions Provides configuration options for the DICOM server startup process, including limits on client connections. ```APIDOC Class DicomServerOptions Description: Configures the DICOM server startup process. Inheritance: System.Object DicomServerOptions Namespace: FellowOakDicom.Network Assembly: fo-dicom.core.dll Syntax: public class DicomServerOptions Properties: MaxClientsAllowed: Declaration: public int MaxClientsAllowed { get; set; } Description: Gets or sets the maximum number of clients allowed for a DICOM server. Unlimited if set to zero. Property Value: Type: System.Int32 Methods: Clone(): Declaration: public DicomServerOptions Clone() Returns: Type: DicomServerOptions Description: ``` -------------------------------- ### DicomCGetApplicationInfo Class and Constructors Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCGetApplicationInfo Documentation for the DicomCGetApplicationInfo class, which extends DicomServiceApplicationInfo to handle DICOM C-GET SOP Class extended negotiation. It implements interfaces for enumerating key-value pairs and provides constructors for initialization. ```APIDOC Class DicomCGetApplicationInfo Inheritance: DicomServiceApplicationInfo Implements: IEnumerable>, IEnumerable Namespace: FellowOakDicom.Network Assembly: fo-dicom.core.dll Description: Implementation of the Retrieve Service Application Information field for the SOP Class Extended Negotiation Sub-item. See http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_C.5.3.html for details on the Service Class Application Information field for C-GET SOP Classes. Constructors: DicomCGetApplicationInfo() Description: Initializes an instance of the DicomCGetApplicationInfo class. Declaration: public DicomCGetApplicationInfo() DicomCGetApplicationInfo(DicomCGetOption options) Description: Initializes an instance of the DicomCGetApplicationInfo class with specified C-GET options. Declaration: public DicomCGetApplicationInfo(DicomCGetOption options) Parameters: - Type: DicomCGetOption Name: options Description: The extended negotiation options for C-Get SOP Classes. ``` -------------------------------- ### DICOM C-MOVE Request Initialization Example Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCMoveRequest Example demonstrating how to initialize a DicomCMoveRequest object in C# for a specific study and series, setting the destination AE and priority. ```C# using FellowOakDicom.Network; // ... string destinationAe = "MY_STORAGE_SCP"; string studyInstanceUid = "1.3.6.1.4.1.9591.100.1.1.1.1"; string seriesInstanceUid = "1.3.6.1.4.1.9591.100.1.1.2.1"; string sopInstanceUid = "1.3.6.1.4.1.9591.100.1.1.3.1"; DicomPriority priority = DicomPriority.High; DicomCMoveRequest request = new DicomCMoveRequest(destinationAe, studyInstanceUid, seriesInstanceUid, sopInstanceUid, priority); // You can also set the OnResponseReceived handler here if needed // request.OnResponseReceived += (sender, args) => { /* handle response */ }; // The request object is now ready to be sent over the network. ``` -------------------------------- ### DicomServiceApplicationInfo Constructors Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServiceApplicationInfo Provides constructors for initializing DicomServiceApplicationInfo instances. One constructor initializes an empty instance, while another allows initialization from a raw byte array representing the application information. ```APIDOC public DicomServiceApplicationInfo() // Initializes an instance of the DicomServiceApplicationInfo class. public DicomServiceApplicationInfo(byte[] rawApplicationInfo) // Initializes an instance of the DicomServiceApplicationInfo class. // Parameters: // rawApplicationInfo: System.Byte[] - Raw byte array with the application info. ``` -------------------------------- ### Dicom Element API: DateFormats and Get Method Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomDateElement Provides documentation for Dicom element properties and methods. Includes the DateFormats property for supported date formats and the generic Get method for retrieving element values. ```APIDOC DateFormats Property: protected string[] DateFormats { get; } Description: Supported date formats. Type: System.String[] ``` ```APIDOC Get Method: public override T Get(int item = -1) Description: Get element value(s). Parameters: item (System.Int32): Item index, if applicable. Returns: T: Value(s) of type `T`, at position `item` if applicable. Type Parameters: T: Return value type. Overrides: DicomMultiStringElement.Get(Int32) Implements: System.IComparable System.IComparable Extension Methods: LinqExtensions.IsOneOf(T, T[]) ``` -------------------------------- ### OutputLUT Constructor Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.LUT.OutputLUT Initializes a new instance of the OutputLUT class with specified grayscale render options, which contain the grayscale color map. ```C# public OutputLUT(GrayscaleRenderOptions options) ``` -------------------------------- ### DicomCStoreApplicationInfo Class Documentation Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCStoreApplicationInfo Provides API documentation for the DicomCStoreApplicationInfo class, including its constructor and properties. It details the types and descriptions of parameters and property values. ```APIDOC DicomCStoreApplicationInfo: Description: Represents application information for DICOM C-STORE operations. Constructor: public DicomCStoreApplicationInfo(byte[] rawApplicationInfo) Parameters: rawApplicationInfo (System.Byte[]): The raw application info byte array. Properties: ElementCoercion: Type: DicomElementCoercion Description: Gets or sets the Element Coercion flag. LevelOfDigitalSignatureSupport: Type: DicomLevelOfDigitalSignatureSupport Description: Gets or sets the Level of Digital Signature support flag. LevelOfSupport: Type: DicomLevelOfSupport Description: Gets or sets the Level of support flag. ``` -------------------------------- ### DicomOtherByte Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomOtherByte Lists the methods available for the DicomOtherByte class, including Equals, Get, and ValidateVM. ```APIDOC Methods: Equals(DicomElement other) Declaration: public override bool Equals(DicomElement other) Parameters: other: [DicomElement](FellowOakDicom.DicomElement.html) Returns: System.Boolean Overrides: FellowOakDicom.DicomValueElement.Equals(FellowOakDicom.DicomElement) Get(Int32 item = -1) Declaration: public override T Get(int item = -1) Parameters: item: System.Int32 (default: -1) Returns: T Type Parameters: T: Description Overrides: FellowOakDicom.DicomValueElement.Get(System.Int32) ValidateVM() Declaration: protected override void ValidateVM() Overrides: [DicomElement.ValidateVM()](FellowOakDicom.DicomElement.html#FellowOakDicom_DicomElement_ValidateVM) ``` -------------------------------- ### GetUInt8 Method Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.IO.IByteSource Gets one byte from the current position and moves to the subsequent position. Returns System.Byte. ```APIDOC GetUInt8() Returns: System.Byte: Single byte. ``` ```C# byte GetUInt8(); ``` -------------------------------- ### DicomPriority Property in C# Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomPriorityRequest Gets or sets the command priority. This property is of type DicomPriority and is accessible for reading and protected for writing. ```C# public DicomPriority Priority { get; protected set; } ``` -------------------------------- ### DicomCFindApplicationInfo Constructors Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCFindApplicationInfo Details the constructors available for initializing DicomCFindApplicationInfo objects. One constructor is parameterless, while the other accepts specific C-FIND options. ```APIDOC Constructors: DicomCFindApplicationInfo() Initializes a new instance of the DicomCFindApplicationInfo class with default settings. Declaration: public DicomCFindApplicationInfo() DicomCFindApplicationInfo(DicomCFindOption options) Initializes a new instance of the DicomCFindApplicationInfo class with specified C-FIND extended negotiation options. Declaration: public DicomCFindApplicationInfo(DicomCFindOption options) Parameters: options: [DicomCFindOption] The extended negotiation options for the C-FIND SOP classes. ``` -------------------------------- ### GetApplicationInfo Method (DicomService) Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomExtendedNegotiation Gets the string representation of the Service Class Application information. ```APIDOC GetApplicationInfo() Gets the string representation of the Service Class Application information. Returns: System.String: The string representation of the application information. ``` -------------------------------- ### DicomCGetApplicationInfo Class Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCGetApplicationInfo Provides documentation for the DicomCGetApplicationInfo class, detailing its constructor and key properties for network application information. ```APIDOC DicomCGetApplicationInfo Class Description: Initializes an instance of the DicomCGetApplicationInfo class. This class provides properties to manage Query/Retrieve View and Relational-retrieval flags. Constructor: DicomCGetApplicationInfo(byte[] rawApplicationInfo) Description: Initializes an instance of the DicomCGetApplicationInfo class. Parameters: - rawApplicationInfo (System.Byte[]): The raw application info byte array. Properties: EnhancedMultiFrameImageConversion Description: Gets or sets the Enhanced Multi-Frame Image Conversion flag. true - Query/Retrieve View supported/requested false - Query/Retrieve View not supported/requested Declaration: public bool EnhancedMultiFrameImageConversion { get; set; } Property Value: System.Boolean RelationalRetrieval Description: Gets or sets the Relational-retrieval flag. true - relational-retrieval supported/requested false - relational-retrieval not supported/requested Declaration: public bool RelationalRetrieval { get; set; } Property Value: System.Boolean ``` -------------------------------- ### DicomClientFactory Create Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.Client.DicomClientFactory Provides static methods to create instances of IDicomClient. These methods allow initialization with specific host, port, and TLS settings, including options for TLS initiation handlers or a simple boolean flag. ```APIDOC DicomClientFactory: Namespace: FellowOakDicom.Network.Client Assembly: fo-dicom.core.dll Methods: Create(string host, int port, ITlsInitiator tlsInitiator, string callingAe, string calledAe) Description: Initializes an instance of IDicomClient using a DI-container. Configures TLS via an ITlsInitiator. Parameters: host (System.String): The DICOM host address. port (System.Int32): The DICOM port number. tlsInitiator (ITlsInitiator): Handler for TLS security initiation. If null, TLS is not enabled. callingAe (System.String): The Calling Application Entity Title. calledAe (System.String): The Called Application Entity Title. Returns: IDicomClient: An initialized DICOM client instance. Create(string host, int port, bool useTls, string callingAe, string calledAe) Description: Initializes an instance of IDicomClient. Configures TLS using a boolean flag. Parameters: host (System.String): The DICOM host address. port (System.Int32): The DICOM port number. useTls (System.Boolean): Set to true to enable TLS security, false otherwise. callingAe (System.String): The Calling Application Entity Title. calledAe (System.String): The Called Application Entity Title. Returns: IDicomClient: An initialized DICOM client instance. ``` -------------------------------- ### DicomCGetRequest.Level Property (C#) Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCGetRequest Gets or sets the Query/Retrieve level of the C-GET operation. This property determines the scope of the query. ```C# public DicomQueryRetrieveLevel Level { get; } ``` -------------------------------- ### C# SourceApplicationEntityTitle Property Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Media.DicomDirectory Gets or sets the source application entity title for a DICOM directory. This property is of type System.String. ```C# public string SourceApplicationEntityTitle { get; set; } ``` -------------------------------- ### DicomSetupBuilder Class API Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomSetupBuilder Provides comprehensive API documentation for the DicomSetupBuilder class. This includes its declaration, constructors, methods with parameters and return types, and inherited members. It is part of the FellowOakDicom namespace. ```APIDOC Class DicomSetupBuilder Namespace: FellowOakDicom Assembly: fo-dicom.core.dll Inheritance: System.Object DicomSetupBuilder Inherited Members: System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Syntax: public class DicomSetupBuilder Constructors: DicomSetupBuilder() Declaration: public DicomSetupBuilder() Description: Initializes a new instance of the DicomSetupBuilder class. Methods: Build() Declaration: public void Build() Description: Builds the DICOM setup. RegisterServices(Action) Declaration: public DicomSetupBuilder RegisterServices(Action registerAction) Parameters: registerAction: System.Action - Action to register services. Returns: DicomSetupBuilder - The DicomSetupBuilder instance for chaining. UseServiceProvider(IServiceProviderHost) Declaration: public static void UseServiceProvider(IServiceProviderHost provider) Parameters: provider: IServiceProviderHost - The service provider host to use. UseServiceProvider(IServiceProvider) Declaration: public static void UseServiceProvider(IServiceProvider provider) Parameters: provider: System.IServiceProvider - The service provider to use. Extension Methods: DicomValidationBuilderExtension.DoValidation(DicomSetupBuilder) DicomValidationBuilderExtension.SkipValidation(DicomSetupBuilder) LinqExtensions.IsOneOf(T, T[]) ``` -------------------------------- ### GetUInt64 Method Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.IO.IByteSource Gets an unsigned long (64 bits) from the current position and moves to the subsequent position. Returns System.UInt64. ```APIDOC GetUInt64() Returns: System.UInt64: Unsigned long. ``` ```C# ulong GetUInt64(); ``` -------------------------------- ### DicomCFindApplicationInfo Class API Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCFindApplicationInfo This entry documents the DicomCFindApplicationInfo class, which is used to configure application information for DICOM C-FIND operations. It includes details on the constructor, various boolean properties for matching and query behaviors, and a static factory method for creating instances tailored for worklist queries. ```APIDOC DicomCFindApplicationInfo(byte[] rawApplicationInfo) Initializes an instance of the DicomCFindApplicationInfo class with raw application information. Parameters: rawApplicationInfo: System.Byte[] - The raw application info byte array. Properties: DateTimeMatching: System.Boolean Gets or sets the Date-time Matching flag. true indicates combined matching is supported/requested; false otherwise. EnhancedMultiFrameImageConversion: System.Boolean Gets or sets the Enhanced Multi-Frame Image Conversion flag. true indicates Query/Retrieve View is supported/requested; false otherwise. FuzzySemanticMatching: System.Boolean Gets or sets the Fuzzy Semantic Matching Of Person Names flag. true indicates fuzzy semantic matching is supported/requested; false otherwise. RelationalQueries: System.Boolean Gets or sets the Relational-Queries flag. true indicates relational queries are supported/requested; false otherwise. TimezoneQueryAdjustment: System.Boolean Gets or sets the Timezone Query Adjustment flag. true indicates Timezone query adjustment is supported/requested; false otherwise. Static Methods: CreateForWorklistQuery(bool fuzzySemanticMatching, bool timezoneQueryAdjustment): DicomCFindApplicationInfo Factory method to create a DicomCFindApplicationInfo instance configured for worklist queries. Parameters: fuzzySemanticMatching: System.Boolean - Flag for fuzzy semantic matching. timezoneQueryAdjustment: System.Boolean - Flag for timezone query adjustment. Returns: DicomCFindApplicationInfo - A new instance configured for worklist queries. ``` -------------------------------- ### Get FilmSession Property (C#) Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Printing.FilmBox Represents the film session object, which holds session-specific printing parameters. ```C# public FilmSession FilmSession { get; } ``` ```APIDOC FilmSession: Type: [FilmSession](FellowOakDicom.Printing.FilmSession.html) Description: Represents the film session. ``` -------------------------------- ### DefaultServiceProviderHost Constructor (C#) Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DefaultServiceProviderHost Initializes a new instance of the DefaultServiceProviderHost class with a specified IServiceProvider. This constructor is essential for setting up the service provider host. ```C# public DefaultServiceProviderHost(IServiceProvider serviceProvider) ``` -------------------------------- ### DicomServiceApplicationInfo Class Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServiceApplicationInfo Provides comprehensive documentation for the methods of the DicomServiceApplicationInfo class, covering operations like checking for fields, creating instances, retrieving values, and managing data. This includes explicit interface implementations. ```APIDOC Contains(Byte): Determines whether the Service Class Application Info contains a field with the specified index. Declaration: public bool Contains(byte index) Parameters: index (System.Byte): Application info field index. Returns: System.Boolean: `True` if exist, otherwise `False` Create(DicomUID, Byte[]): A factory method to initialize a new application information class based on the provided SOP Class. Declaration: public static DicomServiceApplicationInfo Create(DicomUID sopClass, byte[] rawApplicationInfo) Parameters: sopClass ([DicomUID](FellowOakDicom.DicomUID.html)): SOP Class UID. rawApplicationInfo (System.Byte[]): The raw application info byte data. Returns: [DicomServiceApplicationInfo](FellowOakDicom.Network.DicomServiceApplicationInfo.html): The application information class. GetEnumerator(): Returns an enumerator that iterates through the Application Info fields. Declaration: public IEnumerator> GetEnumerator() Returns: System.Collections.Generic.IEnumerator>: Enumerator for the Application Info fields. GetValue(Byte): Get the application info field value. Declaration: public byte GetValue(byte index) Parameters: index (System.Byte): Application info field index. Returns: System.Byte: Application info field value. GetValueAsBoolean(Byte, Boolean): Get the application info field value as a boolean. Declaration: public bool GetValueAsBoolean(byte index, bool defaultValue) Parameters: index (System.Byte): Application info field index. defaultValue (System.Boolean): Default value if Application info field index does not exist. Returns: System.Boolean: `True` if 1 or `False` if 0, or `defaultValue` if index does not exist. GetValueForEnum(Byte, Byte): Get the application info field value for an enum of type T. Declaration: public byte GetValueForEnum(byte index, byte defaultValue) Parameters: index (System.Byte): Application info field index. defaultValue (System.Byte): Default value if Application info field index does not exist. Returns: System.Byte: Application info field value or `defaultValue` if not exists. Type Parameters: T: Enum type to verify values against. Exceptions: System.ArgumentException: `T` is not an Enum. GetValues(): Get the raw Service Class Application Information field. Declaration: public byte[] GetValues() Returns: System.Byte[]: Service Class Application Information field. Remove(Byte): Removes the field with the specified index from the Service Class Application Info. Declaration: public bool Remove(byte index) Parameters: index (System.Byte): Application info field index. Returns: System.Boolean: `True` if successful removed, `False` otherwise. ToString(): Returns a string that represents the current object. Declaration: public override string ToString() Returns: System.String: A string that represents the current object. Overrides: System.Object.ToString() IEnumerable.GetEnumerator(): Returns an enumerator that iterates through the Application Info fields. Declaration: IEnumerator IEnumerable.GetEnumerator() Returns: System.Collections.IEnumerator: Enumerator for the Application Info fields. Implements: System.Collections.Generic.IEnumerable System.Collections.IEnumerable ``` -------------------------------- ### Get Negotiation Result Description Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomPresentationContext Retrieves a user-friendly description of the outcome of a DICOM presentation context negotiation process. ```APIDOC GetResultDescription() Get user-friendly description of negotiation result. Returns: System.String: User-friendly description of negotiation result. ``` -------------------------------- ### OverlayGraphic Class Documentation Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.Render.OverlayGraphic Detailed documentation for the OverlayGraphic class, including its constructor and methods for rendering and scaling overlays. ```APIDOC OverlayGraphic: Namespace: FellowOakDicom.Imaging.Render Assembly: fo-dicom.core.dll Inheritance: System.Object -> OverlayGraphic Description: The Overlay Graphic which render overlay over pixel data. Constructors: OverlayGraphic(SingleBitPixelData pixelData, int offsetx, int offsety, int color) Description: Initialize new instance of OverlayGraphic. Parameters: pixelData: SingleBitPixelData - Overlay pixel data offsetx: System.Int32 - X offset offsety: System.Int32 - Y offset color: System.Int32 - The color of the resulting overlay Methods: Render(int[] pixels, int width, int height) Description: Render overlay graphic. Parameters: pixels: System.Int32[] - Pixels subject to rendering. width: System.Int32 - Width of the pixel array. height: System.Int32 - Height of the pixel array. Scale(double scale) Description: Set overlay scale factor. Parameters: scale: System.Double - Scale factor. ``` -------------------------------- ### TemporaryFile.StoragePath Property Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.IO.TemporaryFile Gets or sets the directory location for temporary files. This static property allows configuration of where temporary files are created. ```APIDOC StoragePath: Description: Gets or sets the directory location of the temporary files. Type: System.String Access: public static string { get; set; } ``` -------------------------------- ### AReleaseRQ Constructor Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.AReleaseRQ Initializes a new instance of the AReleaseRQ class. It requires an IMemoryProvider to manage buffer allocations for the PDU. ```APIDOC AReleaseRQ(IMemoryProvider memoryProvider) Initializes a new A-RELEASE-RQ. Parameters: memoryProvider: The memory provider that will be used to allocate buffers. ``` -------------------------------- ### C# Property: SmoothingType Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Printing.FilmBox Gets or sets the SmoothingType, which further specifies the interpolation function. This is only valid when Magnification Type is CUBIC. ```C# public string SmoothingType { get; set; } ``` -------------------------------- ### DicomServerFactory Create Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomServerFactory Provides static methods to create DICOM server instances. These methods allow configuration of the server's port, IP address, TLS handling, encoding, logging, and service options. ```APIDOC DicomServerFactory Methods: Create(int port, ITlsAcceptor tlsAcceptor = null, Encoding fallbackEncoding = null, ILogger logger = null, object userState = null, Action configure = null) - Creates a DICOM server object out of DI-container. - Parameters: - port (System.Int32): Port to listen to. - tlsAcceptor (ITlsAcceptor): Handler to accept authenticated connections. - fallbackEncoding (System.Text.Encoding): Fallback encoding. - logger (Microsoft.Extensions.Logging.ILogger): Logger, if null default logger will be applied. - userState (System.Object): Optional parameters - configure (Action): Configures the service options of the newly created DICOM server. - Returns: - IDicomServer: An instance of DicomServer, that starts listening for connections in the background. - Type Parameters: - T: DICOM service that the server should manage. Create(string ipAddress, int port, ITlsAcceptor tlsAcceptor = null, Encoding fallbackEncoding = null, ILogger logger = null, object userState = null, Action configure = null) - Creates a DICOM server object out of DI-container. - Parameters: - ipAddress (System.String): IP address(es) to listen to. Value null applies default, IPv4Any. - port (System.Int32): Port to listen to. - tlsAcceptor (ITlsAcceptor): Handler to accept authenticated connections. - fallbackEncoding (System.Text.Encoding): Fallback encoding. - logger (Microsoft.Extensions.Logging.ILogger): Logger, if null default logger will be applied. - userState (System.Object): Optional parameters - configure (Action): Configures the service options of the newly created DICOM server. - Returns: - IDicomServer: An instance of DicomServer, that starts listening for connections in the background. - Type Parameters: - T: DICOM service that the server should manage. Create(string ipAddress, int port, object userState = null, ITlsAcceptor tlsAcceptor = null, Encoding fallbackEncoding = null, ILogger logger = null, Action configure = null) - Creates a DICOM server object out of DI-container. - Parameters: - ipAddress (System.String): IP address(es) to listen to. Value null applies default, IPv4Any. - port (System.Int32): Port to listen to. - userState (System.Object): Optional optional parameters. - tlsAcceptor (ITlsAcceptor): Handler to accept authenticated connections. - fallbackEncoding (System.Text.Encoding): Fallback encoding. - logger (Microsoft.Extensions.Logging.ILogger): Logger, if null default logger will be applied. - configure (Action): Configures the service options of the newly created DICOM server. - Returns: - IDicomServer: An instance of DicomServer, that starts listening for connections in the background. - Type Parameters: - T: DICOM service that the server should manage. - TServer: The type of the DICOM server. ``` -------------------------------- ### C# Property: ReferencedPresentationLutSequence Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Printing.FilmBox Gets or sets the ReferencedPresentationLutSequence for the FilmBox. This sequence typically contains references to presentation LUTs. ```C# public DicomSequence ReferencedPresentationLutSequence { get; set; } ``` -------------------------------- ### ImageBase Class Documentation Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.ImageBase-1 Detailed documentation for the abstract base class `ImageBase`, providing core functionality for image implementations within the `FellowOakDicom.Imaging` namespace. Includes constructors, fields, properties, and methods. ```APIDOC Class: ImageBase Namespace: FellowOakDicom.Imaging Assembly: fo-dicom.core.dll Inheritance: System.Object -> ImageBase -> ImageDisposableBase -> RawImage Implements: IImage, System.IDisposable Syntax: public abstract class ImageBase : IImage, IDisposable where TImage : class Type Parameters: - TImage: Image implementation type. Constructors: - ImageBase(int width, int height, PinnedIntArray pixels, TImage image) Description: Initializes an instance of the ImageBase object. Parameters: - width (System.Int32): Image width. - height (System.Int32): Image height. - pixels (PinnedIntArray): Array of pixels. - image (TImage): Image object. Fields: - _disposed (protected bool) - _height (protected readonly int) - _image (protected TImage) - _pixels (protected PinnedIntArray) - _width (protected readonly int) Properties: - Height (public int { get; }): Image height. - Pixels (public PinnedIntArray { get; }): Gets the array of pixels associated with the image. - Width (public int { get; }): Image width. Methods: - As() : T Description: Cast IImage object to specific (real image) type. Type Parameters: - T: Real image type to cast to. Returns: IImage object as specific (real image) type. - Clone() : IImage Description: Creates a deep copy of the image. Returns: Deep copy of this image. - Dispose() : void Description: Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - Dispose(bool disposing) : void Description: Dispose resources. Parameters: - disposing (System.Boolean): Dispose mode? - DrawGraphics(IEnumerable graphics) : void Description: Draw graphics onto existing image. Parameters: - graphics (System.Collections.Generic.IEnumerable): Graphics to draw. - Finalize() : void Description: Destructor to free up the image resources. - GetPixel(int x, int y) : Color32 Description: Retrieves the pixel color at the specified coordinates. Parameters: - x (System.Int32): The x-coordinate of the pixel. - y (System.Int32): The y-coordinate of the pixel. Returns: The Color32 value of the pixel. - Render(int width, bool flip, bool rotate, int rotation) : void Description: Renders the image given the specified parameters. Parameters: - width (System.Int32): The desired width for rendering. - flip (System.Boolean): Whether to flip the image. - rotate (System.Boolean): Whether to rotate the image. - rotation (System.Int32): The rotation angle in degrees. ``` -------------------------------- ### C# Property: PresentationLut Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Printing.FilmBox Gets the PresentationLut associated with the FilmBox. This property provides access to the presentation LUT settings. ```C# public PresentationLut PresentationLut { get; } ``` -------------------------------- ### PaletteColorLUT Constructor Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.LUT.PaletteColorLUT Initializes a new instance of the PaletteColorLUT class. It requires the first entry value (minimum value) and an array of Color32 objects representing the palette color LUT. ```APIDOC PaletteColorLUT Constructor: Signature: public PaletteColorLUT(int firstEntry, Color32[] lut) Description: Initialize new instance of [PaletteColorLUT](FellowOakDicom.Imaging.LUT.PaletteColorLUT.html) Parameters: - firstEntry (System.Int32): The first entry (minium value) - lut ([Color32](FellowOakDicom.Imaging.Color32.html)[]): The palette color LUT ``` -------------------------------- ### NetworkManager MachineNameImpl Property Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.NetworkManager Abstract property to get the implementation of the machine name, intended for derived classes. ```APIDOC MachineNameImpl: protected abstract string { get; } - Implementation of the machine name getter. ``` -------------------------------- ### IDicomServerRegistry Methods (APIDOC) Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.IDicomServerRegistry Provides documentation for the methods of the IDicomServerRegistry interface, including getting, checking availability, registering, and unregistering DICOM servers. ```APIDOC IDicomServerRegistry Interface Namespace: FellowOakDicom.Network Assembly: fo-dicom.core.dll Methods: Get(Int32, String) Gets a running DICOM server listening on the provided port, or NULL if no such DICOM server exists. Declaration: DicomServerRegistration Get(int port, string ipAddress = "0.0.0.0") Parameters: - port (System.Int32): The port. - ipAddress (System.String): The IP address (defaults to "0.0.0.0"). Returns: - [DicomServerRegistration](FellowOakDicom.Network.DicomServerRegistration.html): A DICOM server registration or null. IsAvailable(Int32, String) Checks whether listening to the provided port at the provided IP address is still possible. Declaration: bool IsAvailable(int port, string ipAddress = "0.0.0.0") Parameters: - port (System.Int32): The port. - ipAddress (System.String): The IP address (defaults to "0.0.0.0"). Returns: - System.Boolean: True when a new DICOM server can be set up for that IP address and port. Register(IDicomServer, Task) Register a new DICOM server. Declaration: DicomServerRegistration Register(IDicomServer dicomServer, Task task) Parameters: - dicomServer ([IDicomServer](FellowOakDicom.Network.IDicomServer.html)): The DICOM server that is now running. - task (System.Threading.Tasks.Task): The task that represents the running of the DICOM server. Returns: - [DicomServerRegistration](FellowOakDicom.Network.DicomServerRegistration.html): A DICOM server registration. Unregister(DicomServerRegistration) Unregisters a DICOM server. This needs to happen when the DICOM server is stopped. Declaration: void Unregister(DicomServerRegistration registration) Parameters: - registration ([DicomServerRegistration](FellowOakDicom.Network.DicomServerRegistration.html)): The registration to unregister. ``` -------------------------------- ### DefaultServiceProviderHost API Documentation Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DefaultServiceProviderHost Provides detailed API documentation for the DefaultServiceProviderHost class, including its inheritance, implemented interfaces, constructors, and methods. ```APIDOC Class: DefaultServiceProviderHost Namespace: FellowOakDicom Assembly: fo-dicom.core.dll Inheritance: System.Object DefaultServiceProviderHost Implements: IServiceProviderHost Constructors: DefaultServiceProviderHost(IServiceProvider serviceProvider) Parameters: serviceProvider: System.IServiceProvider - The service provider to host. Methods: GetServiceProvider(): IServiceProvider Returns: System.IServiceProvider - The hosted service provider. Extension Methods: LinqExtensions.IsOneOf(T, T[]) (FellowOakDicom.Tools.LinqExtensions) ``` -------------------------------- ### BitList Class Documentation Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.Mathematics Documentation for the BitList class, which likely manages a list of bits. ```APIDOC FellowOakDicom.Imaging.Mathematics.BitList Documentation for the BitList class. ``` -------------------------------- ### DicomVR ToString() Method Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomVR Gets a string representation of the VR. This method overrides the base System.Object.ToString() method and returns the VR code as a System.String. ```APIDOC ToString(): string Description: Gets a string representation of this VR. Overrides: System.Object.ToString() Returns: Type: System.String Description: VR code ``` -------------------------------- ### GenericGrayscalePipeline Constructor Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.Render.GenericGrayscalePipeline Initializes a new instance of the GenericGrayscalePipeline. The pipeline consists of a sequence of Rescale (Modality) LUT, VOI LUT, and Output LUT, with an optional Invert LUT based on grayscale options. ```APIDOC Constructor: GenericGrayscalePipeline(GrayscaleRenderOptions options) Description: Initialize new instance of GenericGrayscalePipeline which consist of the following sequence Rescale (Modality) LUT -> VOI LUT -> Output LUT and optionally Invert LUT if specified by grayscale options. Parameters: - options: Type: GrayscaleRenderOptions. Description: Grayscale options to use in the pipeline. ``` ```csharp public GenericGrayscalePipeline(GrayscaleRenderOptions options) ``` -------------------------------- ### DicomUniqueIdentifier Methods Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomUniqueIdentifier Lists the methods of the DicomUniqueIdentifier class. The Get method is overridden to retrieve elements, potentially with type casting. ```APIDOC Methods: Get(Int32) Declaration: public override T Get(int item = -1) Parameters: item: System.Int32 Returns: Type: T Type Parameters: T: Overrides: [DicomMultiStringElement.Get(Int32)](FellowOakDicom.DicomMultiStringElement.html#FellowOakDicom_DicomMultiStringElement_Get__1_System_Int32_) ``` -------------------------------- ### PaletteColorPipeline API Documentation Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Imaging.Render.PaletteColorPipeline Provides detailed API information for the PaletteColorPipeline class, including its constructor, properties, and methods. ```APIDOC PaletteColorPipeline: Implements the IPipeline interface for palette color processing. Constructors: PaletteColorPipeline(DicomPixelData pixelData) Initializes a new instance of the PaletteColorPipeline class. Parameters: pixelData: DicomPixelData - Dicom Pixel Data containing palette color LUT. Properties: LUT: ILUT { get; } Gets the PaletteColorLUT. Property Value: ILUT - The PaletteColorLUT. Methods: ClearCache(): void Removes all cached data, keeping only configuration data to reduce memory consumption. Signature: public void ClearCache() Inherited Members: System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Extension Methods: LinqExtensions.IsOneOf(T, T[]) Checks if a value is present in an array of values. Signature: public static bool IsOneOf(this T value, params T[] values) Parameters: value: T - The value to check. values: T[] - The array of values to compare against. Returns: bool - True if the value is found in the array, false otherwise. ``` -------------------------------- ### DicomElement.Length Property Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomElement Gets the length of the DICOM element's data in bytes. This property provides the size of the raw data buffer associated with the element. ```APIDOC Length : uint { get; } Description: The length of the element's data. ``` -------------------------------- ### DicomCStoreApplicationInfo Class API Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.DicomCStoreApplicationInfo Provides API documentation for the DicomCStoreApplicationInfo class, detailing its inheritance, implementation, syntax, and constructors. This class is part of the Fellow Oak DICOM library for network operations. ```APIDOC Class DicomCStoreApplicationInfo Inheritance: DicomServiceApplicationInfo Implements: IEnumerable>, IEnumerable Namespace: FellowOakDicom.Network Assembly: fo-dicom.core.dll Syntax: public class DicomCStoreApplicationInfo : DicomServiceApplicationInfo, IEnumerable>, IEnumerable Constructors: DicomCStoreApplicationInfo() Declaration: public DicomCStoreApplicationInfo() DicomCStoreApplicationInfo(DicomLevelOfSupport, DicomLevelOfDigitalSignatureSupport, DicomElementCoercion) Description: Initializes an instance of the DicomCStoreApplicationInfo class. Declaration: public DicomCStoreApplicationInfo(DicomLevelOfSupport levelOfSupport, DicomLevelOfDigitalSignatureSupport levelOfDigitalSignatureSupport, DicomElementCoercion elementCoercion) Parameters: levelOfSupport: The level of support for the DICOM service. levelOfDigitalSignatureSupport: The level of digital signature support. elementCoercion: The element coercion strategy. ``` -------------------------------- ### DicomElement.Count Property Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomElement Gets the number of values that the DICOM element contains. This is an abstract property, meaning derived classes must provide their specific implementation. ```APIDOC Count : int { get; } Description: Number of value items in the element. ``` -------------------------------- ### DicomElement.Buffer Property Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.DicomElement Gets or sets the IByteBuffer containing the raw data for the DICOM element. This property is protected, allowing derived classes to access and modify the buffer. ```APIDOC Buffer : IByteBuffer { get; protected set; } Description: The raw data buffer of the DICOM element. ``` -------------------------------- ### AAssociateRJ Constructors Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Network.AAssociateRJ Details the constructors for initializing AAssociateRJ objects, specifying memory providers and rejection details. ```APIDOC Constructors: AAssociateRJ(IMemoryProvider memoryProvider) Initializes new A-ASSOCIATE-RJ. Parameters: memoryProvider: The memory provider that will be used to allocate buffers. AAssociateRJ(DicomRejectResult rt, DicomRejectSource so, DicomRejectReason rn, IMemoryProvider memoryProvider) Initializes new A-ASSOCIATE-RJ. Parameters: rt: Rejection result. so: Rejection source. rn: Rejection reason. memoryProvider: The memory provider that will be used to allocate buffers. ``` -------------------------------- ### C# Property: SOPInstanceUID Source: https://fo-dicom.github.io/stable/v5/api/FellowOakDicom.AppendDicomTransformRule.html/FellowOakDicom.Printing.FilmBox Gets the basic film box SOP instance UID. This unique identifier is crucial for referencing the FilmBox instance. ```C# public DicomUID SOPInstanceUID { get; } ```