Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DicoogleAccess

Index

Properties

queryRetrieve

queryRetrieve: QueryRetrieveService

Namespace for DICOM Query/Retrieve service management.

storage

Namespace for DICOM Storage service management.

tasks

tasks: Tasks

Namespace for task management.

Methods

dump

  • dump(uid: string, provider: string | string[], callback: function): void
  • dump(uid: string, callback: function): void
  • Retrieve an image's meta-data (perform an information dump)

    Parameters

    • uid: string

      the SOP instance UID

    • provider: string | string[]

      a list of provider plugins

    • callback: function

      the callback function

    Returns void

  • Retrieve an image's meta-data (perform an information dump)

    Parameters

    • uid: string

      the SOP instance UID

    • callback: function

      the callback function

    Returns void

getAETitle

  • getAETitle(callback: function): void
  • Retrieve the AE title of the Dicoogle archive.

    Parameters

    • callback: function

      the callback function

        • (error: Error, aetitle: string): void
        • Parameters

          • error: Error
          • aetitle: string

          Returns void

    Returns void

getBase

  • getBase(): string
  • Obtain the base URL of all Dicoogle services. This method is synchronous.

    Returns string

    the currently configured base endpoint of Dicoogle

getDicomQuerySettings

  • getDicomQuerySettings(callback: function): void

getIndexProviders

  • getIndexProviders(callback: function): void
  • Retrieve a list of index provider plugins

    Parameters

    • callback: function

      the callback function

        • (error: Error, outcome: string[]): void
        • Parameters

          • error: Error
          • outcome: string[]

          Returns void

    Returns void

getIndexerSettings

  • getIndexerSettings(callback: function): void

getPreviewUrl

  • getPreviewUrl(id: string, frame?: number): string
  • Obtain a URL pointing to an item's quick preview of the image. This function is synchronous.

    Parameters

    • id: string

      a SOPInstanceUID or URI of the item

    • Optional frame: number

      the frame number, if applicable

    Returns string

    the full URL to the preview

getProviders

  • getProviders(type: string, callback: function): void
  • getProviders(callback: function): void
  • Retrieve a list of provider plugins

    Parameters

    • type: string

      the type of provider ("query", "index", ...) - defaults to "query"

    • callback: function

      the callback function

        • (error: Error, outcome: string[]): void
        • Parameters

          • error: Error
          • outcome: string[]

          Returns void

    Returns void

  • Retrieve a list of query provider plugins

    Parameters

    • callback: function

      the callback function

        • (error: Error, outcome: string[]): void
        • Parameters

          • error: Error
          • outcome: string[]

          Returns void

    Returns void

getQueryProviders

  • getQueryProviders(callback: function): void
  • Retrieve a list of query provider plugins

    Parameters

    • callback: function

      the callback function

        • (error: Error, outcome: string[]): void
        • Parameters

          • error: Error
          • outcome: string[]

          Returns void

    Returns void

getRawLog

  • getRawLog(callback: function): void
  • Retrieve the Dicoogle server's log text.

    Parameters

    • callback: function

      the callback function

        • (error: Error, text: string): void
        • Parameters

          • error: Error
          • text: string

          Returns void

    Returns void

getRoles

  • getRoles(): string[]
  • Get the names of the roles assigned to this user.

    Returns string[]

    an array of role names, null if the user is not authenticated

getStorageProviders

  • getStorageProviders(callback: function): void
  • Retrieve a list of storage provider plugins

    Parameters

    • callback: function

      the callback function

        • (error: Error, outcome: string[]): void
        • Parameters

          • error: Error
          • outcome: string[]

          Returns void

    Returns void

getThumbnailUrl

  • getThumbnailUrl(id: string, frame?: number): string
  • Obtain a URL pointing to an item's thumbnail. This function is synchronous.

    Parameters

    • id: string

      a SOPInstanceUID or URI of the item

    • Optional frame: number

      the frame number, if applicable

    Returns string

    the full URL to the thumbnail

getToken

  • getToken(): string
  • [EXPERTS] Retrieve the authentication token. This token is ephemeral and may expire after some time. This method is synchronous. Use it only when you know what you are doing.

    Returns string

    the user's current authentication token

getTransferSyntaxSettings

  • getTransferSyntaxSettings(callback: function): void

getUsername

  • getUsername(): string

getVersion

  • getVersion(callback: function): void
  • Retrieve the running Dicoogle version.

    Parameters

    • callback: function
        • (error: Error, outcome: object): void
        • Parameters

          • error: Error
          • outcome: object
            • version: string

          Returns void

    Returns void

getWebUIPlugins

  • getWebUIPlugins(slotId: string | string[], callback: function): void
  • Retrieve information about currently installed web UI plugins.

    Parameters

    • slotId: string | string[]

      the identifiers of slots to contemplate

    • callback: function

      the callback function

    Returns void

index

  • index(uri: string, callback: function): void
  • index(uri: string, provider: string | string[], callback: function): void
  • Request a new indexing task over a given URI. The operation is recursive, indexing anything in the URI's endpoint. The callback will be called after the task is created, not when it is complete.

    Parameters

    • uri: string

      a URI or array of URIs representing the root resource of the files to be indexed

    • callback: function

      the function to call when the task is successfully issued

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

  • Request a new indexing task over a given URI. The operation is recursive, indexing anything in the URI's endpoint. The callback will be called after the task is created, not when it is complete.

    Parameters

    • uri: string

      a URI or array of URIs representing the root resource of the files to be indexed

    • provider: string | string[]

      a provider or array of provider names in which the indexing will carry out, all by default

    • callback: function

      the function to call when the task is successfully issued

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

isAuthenticated

  • isAuthenticated(): boolean
  • Check whether the user is authenticated to the server. Authenticated clients will hold an authentication token.

    Returns boolean

    whether the user is authenticated or not.

issueExport

  • issueExport(query: string, fields: string | string[], options: ExportOptions, callback: function): void
  • issueExport(query: string, fields: string | string[], callback: function): void
  • Request a CSV file export of the results.

    Parameters

    • query: string

      the query to perform

    • fields: string | string[]

      a set of field names to be passed to the query providers when requesting the query. The same fields will be provided in the resulting CSV file, in the given order.

    • options: ExportOptions

      additional options

    • callback: function

      the callback function providing the UID of the file

        • (error: Error, uid: string): void
        • Parameters

          • error: Error
          • uid: string

          Returns void

    Returns void

  • Request a CSV file export of the results.

    Parameters

    • query: string

      the query to perform

    • fields: string | string[]

      a set of field names to be passed to the query providers when requesting the query. The same fields will be provided in the resulting CSV file, in the given order.

    • callback: function

      the callback function providing the UID of the file

        • (error: Error, uid: string): void
        • Parameters

          • error: Error
          • uid: string

          Returns void

    Returns void

login

  • login(username: string, password: password, callback?: function): void
  • Manually log in to Dicoogle using the given credentials.

    Parameters

    • username: string

      the unique user name for the client

    • password: password

      the user's password for authentication

    • Optional callback: function

      the callback function, providing the authentication token and other information

    Returns void

logout

  • logout(callback?: function): void
  • Log out from the server.

    Parameters

    • Optional callback: function

      the callback function

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

remove

  • remove(uri: string, callback: function): void
  • Request that the file at the given URI is permanently removed. The operation, unlike index(), is not recursive. Indices will not be updated, hence the files should be unindexed manually if so is intended.

    Parameters

    • uri: string

      a URI or array of URIs representing the files to be removed

    • callback: function

      the function to call on completion

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

request

  • request(method: string, uri: string | string[]): SuperAgent
  • request(uri: string | string[]): SuperAgent
  • Perform a generic request to Dicoogle's services. Users of this method can invoke any REST service exposed by Dicoogle, including those from plugins. The resulting object is a SuperAgent request.

    Parameters

    • method: string

      the kind of HTTP method to make, defaults to "GET"

    • uri: string | string[]

      a URI or array of resource sequences to the service, relative to Dicoogle's base URL. There should be no leading slash ('/').

    Returns SuperAgent

    a superagent request object

  • Perform a generic GET request to Dicoogle's services. Users of this method can invoke any REST service exposed by Dicoogle, including those from plugins. The resulting object is a SuperAgent request.

    Parameters

    • uri: string | string[]

      a URI or array of resource sequences to the service, relative to Dicoogle's base URL. There should be no leading slash ('/').

    Returns SuperAgent

    a superagent request object

reset

  • reset(): void
  • [EXPERTS] Clear this object's user session information. This method is synchronous. Use it only when you know what you are doing.

    Returns void

restoreSession

  • restoreSession(token: string, callback: function): void
  • Restore a living Dicoogle session identified by the given token.

    Parameters

    • token: string

      the same user's token of a previous session

    • callback: function

      the callback function providing user information

        • (error: Error, outcome: UserInfo): void
        • Parameters

          Returns void

    Returns void

search

  • search(query: string, callback: function): void
  • search(query: string, options: SearchOptions, callback: function): void
  • Perform a text query.

    Parameters

    • query: string

      the text query

    • callback: function

      the callback function providing the outcome

    Returns void

  • Perform a text query.

    Parameters

    • query: string

      the text query

    • options: SearchOptions

      a hash of options related to the search

    • callback: function

      the callback function providing the outcome

    Returns void

searchDIM

  • searchDIM(query: string, callback: function): void
  • searchDIM(query: string, options: SearchDIMOptions, callback: function): void
  • Perform a text query with DIM-formatted outcome.

    Parameters

    • query: string

      the text query

    • callback: function

      the callback function providing the outcome

    Returns void

  • Perform a text query with DIM-formatted outcome.

    Parameters

    • query: string

      the text query

    • options: SearchDIMOptions

      a hash of options related to the search

    • callback: function

      the callback function providing the outcome

    Returns void

setAETitle

  • setAETitle(aetitle: string, callback: function): void
  • Redefine the AE title of the Dicoogle archive.

    Parameters

    • aetitle: string

      a valid AE title for the PACS archive

    • callback: function

      the callback function

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

setDicomQuerySettings

  • Set a group of DICOM Query/Retrieve settings. The given object should contain valid field-value pairs.

    Parameters

    • fields: DicomQuerySettings

      a dictionary containing the fields and values as key-value pairs.

    • callback: function

      the callback function

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

setIndexerSettings

  • setIndexerSettings(field: string, value: any, callback: function): void
  • setIndexerSettings(fields: IndexerSettings, callback: function): void
  • Set a particular Indexer setting. A valid field and value pair is required.

    Parameters

    • field: string

      a particular field to set

    • value: any

      the value to assign to the field

    • callback: function

      the callback function

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

  • Set a group of indexer settings. The given object should contain valid field-value pairs.

    Parameters

    • fields: IndexerSettings

      a dictionary containing the fields and values as key-value pairs.

    • callback: function

      the callback function

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

setToken

  • setToken(token: string): void
  • [EXPERTS] Assign the module's session token internally. This method is synchronous. Use it only when you know what you are doing. When restoring a previous (but still living) session, please prefer [@link restoreSession] instead.

    Parameters

    • token: string

      the same user's token of a previous session

    Returns void

setTransferSyntaxOption

  • setTransferSyntaxOption(uid: string, option: string, value: boolean, callback: function): void
  • Set (or reset) an option of a particular transfer syntax.

    Parameters

    • uid: string

      the unique identifier of the transfer syntax

    • option: string

      the name of the option to modify

    • value: boolean

      whether to set (true) or reset (false) the option

    • callback: function

      the callback function

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

unindex

  • unindex(uri: string, callback: function): void
  • unindex(uri: string, provider: string | string[], callback: function): void
  • Request that the file at the given URI is unindexed in all indexers. The operation, unlike index(), is not recursive and will not unindex sub-entries.

    Parameters

    • uri: string

      a URI or array of URIs representing the files to be unindexed

    • callback: function

      the function to call on completion

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

  • Request that the file at the given URI is unindexed to a specific set of indexers. The operation, unlike index(), is not recursive and will not unindex sub-entries.

    Parameters

    • uri: string

      a URI or array of URIs representing the files to be unindexed

    • provider: string | string[]

      a provider or array of provider names in which the unindexing will carry out, all by default

    • callback: function

      the function to call on completion

        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns void

Generated using TypeDoc