Core
in package
Class that wraps around the free PMA.core.lite (the server component of PMA.start), as well as its commercial variant; the PMA.core product
Table of Contents
- $__version__ : mixed
- $_pma_amount_of_data_downloaded : mixed
- $_pma_debug : mixed
- $_pma_pmacoreliteSessionID : mixed
- $_pma_pmacoreliteURL : mixed
- $_pma_sessions : mixed
- $_pma_slideinfos : mixed
- $_pma_usernames : mixed
- $annotation_source_format_aperio : mixed
- $annotation_source_format_definiens : mixed
- $annotation_source_format_indicalabs : mixed
- $annotation_source_format_native : mixed
- $annotation_source_format_pathomation : mixed
- $annotation_source_format_visiopharm : mixed
- $annotation_source_format_xml : mixed
- $annotation_target_format_aperio : mixed
- $annotation_target_format_csv : mixed
- $annotation_target_format_definiens : mixed
- $annotation_target_format_indicalabs : mixed
- $annotation_target_format_pathomation : mixed
- $annotation_target_format_visiopharm : mixed
- $annotation_target_format_xml : mixed
- $_pma_usecachewhenretrievingtiles : mixed
- $_previous_downloaded : mixed
- _pma_session_id() : mixed
- Internal use only
- _pma_url() : mixed
- Internal use only
- addAnnotation() : mixed
- Adds an anotation (in WKT format) to a slide with the specified parameters
- addAnnotationFile() : mixed
- connect() : mixed
- Attempt to connect to PMA.core instance; success results in a SessionID
- detachAnnotationFile() : mixed
- disconnect() : mixed
- Attempt to connect to PMA.core instance; success results in a SessionID
- download() : mixed
- Downloads a slide
- getAnnotationByID() : mixed
- Retrieve one particular annotation, based on its ID
- getAnnotationFiles() : mixed
- Get a list of attached external annotation files (Visiopharm MLD, Indica Labs ANNOTATION...)
- getAnnotations() : mixed
- Retrieve the annotations for slide slideRef
- getAPIVersion() : mixed
- getAPIVersionString() : mixed
- getAssociatedImageTypes() : mixed
- Return the list of images type associated with a slide
- getAvailableForms() : mixed
- See what forms are available to fill out, either system-wide (leave slideref to None), or for a particular slide
- getBarcodeImage() : mixed
- Get the barcode (alias for "label") image for a slide
- getBarcodeText() : mixed
- Get the text encoded by the barcode (if there IS a barcode on the slide to begin with)
- getBarcodeUrl() : mixed
- Get the URL that points to the barcode (alias for "label") for a slide
- getBuildRevision() : mixed
- Get build revision info from PMA.core instance running at $pmacoreURL
- getCompositeThumbnailImage() : mixed
- Get a composite thumbnail for any number of slides The function results thumbnails for up to the first 4 slides in an array; if there are more than 4 slides, then a message is included in the resulting composite
- getDirectories() : mixed
- Return an array of sub-directories available to $sessionID in the $startDir directory
- getFilesForSlide() : mixed
- Obtain all files actually associated with a specific slide This is most relevant with slides that are defined by multiple files, like MRXS or VSI
- getFingerprint() : mixed
- Get the fingerprint for a specific slide
- getFirstNonEmptyDirectory() : mixed
- Look for the first directory in a directory hierarchy that starts at $startDir that has at least one actual slide in it
- getLabelImage() : mixed
- Get the label image for a slide
- getLabelUrl() : mixed
- Get the URL that points to the label for a slide
- getMacroImage() : mixed
- Get the macro image for a slide
- getMacroUrl() : mixed
- Get the URL that points to the macro image for a slide (a low resolution image of the slide overview as well as the barcode; essentially )
- getMagnification() : mixed
- Get the magnification represented at a certain zoomlevel
- getMaxZoomlevel() : mixed
- Determine the maximum zoomlevel that still represents an optical magnification
- getNumberOfChannels() : mixed
- Number of fluorescent channels for a slide (when slide is brightfield, return is always 1)
- getNumberOfLayers() : mixed
- Number of (z-stacked) layers for a slide
- getNumberOfTiles() : mixed
- Determine the number of tiles needed to reconstitute a slide at a given zoomlevel
- getNumberOfZStackLayers() : mixed
- getPhysicalDimensions() : mixed
- Determine the physical dimensions of the sample represented by the slide.
- getPixelDimensions() : mixed
- Get the total dimensions of a slide image at a given zoomlevel
- getPixelsPerMicrometer() : mixed
- Retrieve the physical dimension in terms of pixels per micrometer.
- getPmacoreliteSessionID() : mixed
- returns the value of $_pma_pmacoreliteSessionID
- getRegion() : mixed
- getRegionURL() : mixed
- getRootDirectories() : mixed
- Return an array of root-directories available to $sessionID
- getSlideInfo() : mixed
- Return raw image information in the form of nested dictionaries
- getSlides() : mixed
- Return an array of slides available to sessionID in the startDir directory
- GetSlidesInfo() : mixed
- getThumbnailImage() : mixed
- Get the thumbnail image for a slide
- getThumbnailUrl() : mixed
- Get the URL that points to the thumbnail for a slide
- getTile() : mixed
- Get a single tile at position (x, y) Format can be 'jpg' or 'png' Quality is an integer value and varies from 0 (as much compression as possible; not recommended) to 100 (100%, no compression)
- getTileSize() : mixed
- Gets the tile size for the server
- getTileUrl() : mixed
- Built the URL for a single tile at position (x, y) Format can be 'jpg' or 'png' Quality is an integer value and varies from 0 (as much compression as possible; not recommended) to 100 (100%, no compression)
- getUID() : mixed
- Get the UID (unique identifier) for a specific slide
- getVersionInfo() : mixed
- Get version info from PMA.core instance running at $pmacoreURL
- getZoomlevelsDict() : mixed
- Obtain a dictionary with the number of tiles per zoomlevel.
- isFluorescent() : mixed
- Determine whether a slide is a fluorescent image or not
- isLite() : mixed
- See if there's a PMA.core.lite or PMA.core instance running at $pmacoreURL
- isMultiLayer() : mixed
- Determine whether a slide contains multiple (stacked) layers or not
- isZStack() : mixed
- Determine whether a slide is a z-stack or not
- ping() : mixed
- Validates a sessionID
- registerSession() : mixed
- searchSlides() : mixed
- Search for slides or directories using the pattern
- setDebugFlag() : mixed
- storePmaHostForSessionID() : mixed
- Set pma_host for sessionID
- upload() : mixed
- Upload a slide to a PMA.core server
- whoAmI() : mixed
- return information about the current user (associated with the PMA.core SessionID)
- _pma_api_url() : mixed
- Internal use only
- _pma_first_session_id() : mixed
- Internal use only
- _pma_is_lite() : mixed
- Internal use only
- _pma_query_url() : mixed
- Internal use only
- _pma_transfer_url() : mixed
- Internal use only
- progress() : mixed
- progressUpload() : mixed
Properties
$__version__
public
static mixed
$__version__
= PathomationPmaPhpPMA::version
$_pma_amount_of_data_downloaded
public
static mixed
$_pma_amount_of_data_downloaded
= array("SDK.PHP" => 0)
$_pma_debug
public
static mixed
$_pma_debug
= false
$_pma_pmacoreliteSessionID
public
static mixed
$_pma_pmacoreliteSessionID
= "SDK.PHP"
$_pma_pmacoreliteURL
public
static mixed
$_pma_pmacoreliteURL
= "http://localhost:54001/"
$_pma_sessions
public
static mixed
$_pma_sessions
= []
$_pma_slideinfos
public
static mixed
$_pma_slideinfos
= []
$_pma_usernames
public
static mixed
$_pma_usernames
= []
$annotation_source_format_aperio
public
static mixed
$annotation_source_format_aperio
= 4
$annotation_source_format_definiens
public
static mixed
$annotation_source_format_definiens
= 4
$annotation_source_format_indicalabs
public
static mixed
$annotation_source_format_indicalabs
= 3
$annotation_source_format_native
public
static mixed
$annotation_source_format_native
= 1
$annotation_source_format_pathomation
public
static mixed
$annotation_source_format_pathomation
= 0
$annotation_source_format_visiopharm
public
static mixed
$annotation_source_format_visiopharm
= 2
$annotation_source_format_xml
public
static mixed
$annotation_source_format_xml
= 4
$annotation_target_format_aperio
public
static mixed
$annotation_target_format_aperio
= 3
$annotation_target_format_csv
public
static mixed
$annotation_target_format_csv
= 4
$annotation_target_format_definiens
public
static mixed
$annotation_target_format_definiens
= 3
$annotation_target_format_indicalabs
public
static mixed
$annotation_target_format_indicalabs
= 1
$annotation_target_format_pathomation
public
static mixed
$annotation_target_format_pathomation
= 2
$annotation_target_format_visiopharm
public
static mixed
$annotation_target_format_visiopharm
= 0
$annotation_target_format_xml
public
static mixed
$annotation_target_format_xml
= 3
$_pma_usecachewhenretrievingtiles
private
static mixed
$_pma_usecachewhenretrievingtiles
= true
$_previous_downloaded
private
static mixed
$_previous_downloaded
= -1
Methods
_pma_session_id()
Internal use only
public
static _pma_session_id([mixed $sessionID = null ]) : mixed
Parameters
- $sessionID : mixed = null
Return values
mixed —_pma_url()
Internal use only
public
static _pma_url([mixed $sessionID = null ]) : mixed
Parameters
- $sessionID : mixed = null
Return values
mixed —addAnnotation()
Adds an anotation (in WKT format) to a slide with the specified parameters
public
static addAnnotation(mixed $slideRef, mixed $classification, mixed $notes, mixed $geometry[, mixed $color = "#000000" ], mixed $layerID[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $classification : mixed
- $notes : mixed
- $geometry : mixed
- $color : mixed = "#000000"
- $layerID : mixed
- $sessionID : mixed = null
Return values
mixed —addAnnotationFile()
public
static addAnnotationFile(mixed $slideRef, mixed $annotationFileRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $annotationFileRef : mixed
- $sessionID : mixed = null
Return values
mixed —connect()
Attempt to connect to PMA.core instance; success results in a SessionID
public
static connect([mixed $pmacoreURL = null ][, mixed $pmacoreUsername = "" ][, mixed $pmacorePassword = "" ]) : mixed
Parameters
- $pmacoreURL : mixed = null
- $pmacoreUsername : mixed = ""
- $pmacorePassword : mixed = ""
Return values
mixed —detachAnnotationFile()
public
static detachAnnotationFile(mixed $slideRef, mixed $annotationFileRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $annotationFileRef : mixed
- $sessionID : mixed = null
Return values
mixed —disconnect()
Attempt to connect to PMA.core instance; success results in a SessionID
public
static disconnect([mixed $sessionID = null ]) : mixed
Parameters
- $sessionID : mixed = null
Return values
mixed —download()
Downloads a slide
public
static download(mixed $slide, mixed $saveDirectory[, mixed $sessionID = null ]) : mixed
Parameters
- $slide : mixed
- $saveDirectory : mixed
- $sessionID : mixed = null
Return values
mixed —getAnnotationByID()
Retrieve one particular annotation, based on its ID
public
static getAnnotationByID(mixed $slideref, mixed $annID[, mixed $sessionID = null ]) : mixed
Parameters
- $slideref : mixed
- $annID : mixed
- $sessionID : mixed = null
Return values
mixed —getAnnotationFiles()
Get a list of attached external annotation files (Visiopharm MLD, Indica Labs ANNOTATION...)
public
static getAnnotationFiles(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getAnnotations()
Retrieve the annotations for slide slideRef
public
static getAnnotations(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getAPIVersion()
public
static getAPIVersion([mixed $pmacoreURL = null ]) : mixed
Parameters
- $pmacoreURL : mixed = null
Return values
mixed —getAPIVersionString()
public
static getAPIVersionString([mixed $pmacoreURL = null ]) : mixed
Parameters
- $pmacoreURL : mixed = null
Return values
mixed —getAssociatedImageTypes()
Return the list of images type associated with a slide
public
static getAssociatedImageTypes(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getAvailableForms()
See what forms are available to fill out, either system-wide (leave slideref to None), or for a particular slide
public
static getAvailableForms([mixed $slideref = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $slideref : mixed = null
- $sessionID : mixed = null
Return values
mixed —getBarcodeImage()
Get the barcode (alias for "label") image for a slide
public
static getBarcodeImage(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getBarcodeText()
Get the text encoded by the barcode (if there IS a barcode on the slide to begin with)
public
static getBarcodeText(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getBarcodeUrl()
Get the URL that points to the barcode (alias for "label") for a slide
public
static getBarcodeUrl(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getBuildRevision()
Get build revision info from PMA.core instance running at $pmacoreURL
public
static getBuildRevision([mixed $pmacoreURL = null ]) : mixed
Parameters
- $pmacoreURL : mixed = null
Return values
mixed —getCompositeThumbnailImage()
Get a composite thumbnail for any number of slides The function results thumbnails for up to the first 4 slides in an array; if there are more than 4 slides, then a message is included in the resulting composite
public
static getCompositeThumbnailImage(mixed $slides[, mixed $width = 1200 ][, mixed $height = 630 ][, mixed $sessionID = null ]) : mixed
Parameters
- $slides : mixed
- $width : mixed = 1200
- $height : mixed = 630
- $sessionID : mixed = null
Return values
mixed —getDirectories()
Return an array of sub-directories available to $sessionID in the $startDir directory
public
static getDirectories(mixed $startDir[, mixed $sessionID = null ][, mixed $recursive = False ]) : mixed
Parameters
- $startDir : mixed
- $sessionID : mixed = null
- $recursive : mixed = False
Return values
mixed —getFilesForSlide()
Obtain all files actually associated with a specific slide This is most relevant with slides that are defined by multiple files, like MRXS or VSI
public
static getFilesForSlide(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getFingerprint()
Get the fingerprint for a specific slide
public
static getFingerprint(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getFirstNonEmptyDirectory()
Look for the first directory in a directory hierarchy that starts at $startDir that has at least one actual slide in it
public
static getFirstNonEmptyDirectory([mixed $startDir = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $startDir : mixed = null
- $sessionID : mixed = null
Return values
mixed —getLabelImage()
Get the label image for a slide
public
static getLabelImage(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getLabelUrl()
Get the URL that points to the label for a slide
public
static getLabelUrl(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getMacroImage()
Get the macro image for a slide
public
static getMacroImage(mixed $slideRef[, mixed $width = null ][, mixed $height = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $width : mixed = null
- $height : mixed = null
- $sessionID : mixed = null
Return values
mixed —getMacroUrl()
Get the URL that points to the macro image for a slide (a low resolution image of the slide overview as well as the barcode; essentially )
public
static getMacroUrl(mixed $slideRef[, mixed $width = null ][, mixed $height = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $width : mixed = null
- $height : mixed = null
- $sessionID : mixed = null
Return values
mixed —getMagnification()
Get the magnification represented at a certain zoomlevel
public
static getMagnification(mixed $slideRef[, mixed $zoomlevel = null ][, mixed $exact = False ][, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $zoomlevel : mixed = null
- $exact : mixed = False
- $sessionID : mixed = null
Return values
mixed —getMaxZoomlevel()
Determine the maximum zoomlevel that still represents an optical magnification
public
static getMaxZoomlevel(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getNumberOfChannels()
Number of fluorescent channels for a slide (when slide is brightfield, return is always 1)
public
static getNumberOfChannels(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getNumberOfLayers()
Number of (z-stacked) layers for a slide
public
static getNumberOfLayers(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getNumberOfTiles()
Determine the number of tiles needed to reconstitute a slide at a given zoomlevel
public
static getNumberOfTiles(mixed $slideRef[, mixed $zoomlevel = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $zoomlevel : mixed = null
- $sessionID : mixed = null
Return values
mixed —getNumberOfZStackLayers()
public
static getNumberOfZStackLayers(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getPhysicalDimensions()
Determine the physical dimensions of the sample represented by the slide.
public
static getPhysicalDimensions(mixed $slideRef[, mixed $sessionID = null ]) : mixed
This is independent of the zoomlevel: the physical properties don't change because the magnification changes
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getPixelDimensions()
Get the total dimensions of a slide image at a given zoomlevel
public
static getPixelDimensions(mixed $slideRef[, mixed $zoomlevel = null ][, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $zoomlevel : mixed = null
- $sessionID : mixed = null
Return values
mixed —getPixelsPerMicrometer()
Retrieve the physical dimension in terms of pixels per micrometer.
public
static getPixelsPerMicrometer(mixed $slideRef[, mixed $zoomlevel = null ][, mixed $sessionID = null ]) : mixed
When zoomlevel is left to its default value of None, dimensions at the highest zoomlevel are returned (in effect returning the "native" resolution at which the slide was registered)
Parameters
- $slideRef : mixed
- $zoomlevel : mixed = null
- $sessionID : mixed = null
Return values
mixed —getPmacoreliteSessionID()
returns the value of $_pma_pmacoreliteSessionID
public
static getPmacoreliteSessionID() : mixed
Return values
mixed —getRegion()
public
static getRegion(mixed $slideRef, mixed $x, mixed $y, mixed $width, mixed $height[, mixed $scale = 1 ], mixed $zstack[, mixed $sessionID = null ][, mixed $format = "jpg" ][, mixed $quality = 100 ], mixed $rotation[, mixed $contrast = null ][, mixed $brightness = null ][, mixed $postGamma = null ][, mixed $dpi = 300 ][, mixed $flipVertical = false ][, mixed $flipHorizontal = false ][, mixed $annotationsLayerType = null ], mixed $drawFilename[, mixed $downloadInsteadOfDisplay = false ][, mixed $drawScaleBar = false ]) : mixed
Parameters
- $slideRef : mixed
- $x : mixed
- $y : mixed
- $width : mixed
- $height : mixed
- $scale : mixed = 1
- $zstack : mixed
- $sessionID : mixed = null
- $format : mixed = "jpg"
- $quality : mixed = 100
- $rotation : mixed
- $contrast : mixed = null
- $brightness : mixed = null
- $postGamma : mixed = null
- $dpi : mixed = 300
- $flipVertical : mixed = false
- $flipHorizontal : mixed = false
- $annotationsLayerType : mixed = null
- $drawFilename : mixed
- $downloadInsteadOfDisplay : mixed = false
- $drawScaleBar : mixed = false
Return values
mixed —getRegionURL()
public
static getRegionURL(mixed $slideRef, mixed $x, mixed $y, mixed $width, mixed $height[, mixed $scale = 1 ], mixed $zstack[, mixed $sessionID = null ][, mixed $format = "jpg" ][, mixed $quality = 100 ], mixed $rotation[, mixed $contrast = null ][, mixed $brightness = null ][, mixed $postGamma = null ][, mixed $dpi = 300 ][, mixed $flipVertical = false ][, mixed $flipHorizontal = false ][, mixed $annotationsLayerType = null ], mixed $drawFilename[, mixed $downloadInsteadOfDisplay = false ][, mixed $drawScaleBar = false ]) : mixed
Parameters
- $slideRef : mixed
- $x : mixed
- $y : mixed
- $width : mixed
- $height : mixed
- $scale : mixed = 1
- $zstack : mixed
- $sessionID : mixed = null
- $format : mixed = "jpg"
- $quality : mixed = 100
- $rotation : mixed
- $contrast : mixed = null
- $brightness : mixed = null
- $postGamma : mixed = null
- $dpi : mixed = 300
- $flipVertical : mixed = false
- $flipHorizontal : mixed = false
- $annotationsLayerType : mixed = null
- $drawFilename : mixed
- $downloadInsteadOfDisplay : mixed = false
- $drawScaleBar : mixed = false
Return values
mixed —getRootDirectories()
Return an array of root-directories available to $sessionID
public
static getRootDirectories([mixed $sessionID = null ]) : mixed
Parameters
- $sessionID : mixed = null
Return values
mixed —getSlideInfo()
Return raw image information in the form of nested dictionaries
public
static getSlideInfo(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getSlides()
Return an array of slides available to sessionID in the startDir directory
public
static getSlides(mixed $startDir[, mixed $sessionID = null ][, mixed $recursive = false ]) : mixed
Parameters
- $startDir : mixed
- $sessionID : mixed = null
- $recursive : mixed = false
Return values
mixed —GetSlidesInfo()
public
static GetSlidesInfo(mixed $slideRefs[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRefs : mixed
- $sessionID : mixed = null
Return values
mixed —getThumbnailImage()
Get the thumbnail image for a slide
public
static getThumbnailImage(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getThumbnailUrl()
Get the URL that points to the thumbnail for a slide
public
static getThumbnailUrl(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getTile()
Get a single tile at position (x, y) Format can be 'jpg' or 'png' Quality is an integer value and varies from 0 (as much compression as possible; not recommended) to 100 (100%, no compression)
public
static getTile(mixed $slide, mixed $x, mixed $y[, mixed $zoomlevel = null ], mixed $zstack[, mixed $sessionID = null ][, mixed $format = "jpg" ][, mixed $quality = 100 ]) : mixed
Parameters
- $slide : mixed
- $x : mixed
- $y : mixed
- $zoomlevel : mixed = null
- $zstack : mixed
- $sessionID : mixed = null
- $format : mixed = "jpg"
- $quality : mixed = 100
Return values
mixed —getTileSize()
Gets the tile size for the server
public
static getTileSize([mixed $sessionID = null ]) : mixed
Parameters
- $sessionID : mixed = null
Return values
mixed —getTileUrl()
Built the URL for a single tile at position (x, y) Format can be 'jpg' or 'png' Quality is an integer value and varies from 0 (as much compression as possible; not recommended) to 100 (100%, no compression)
public
static getTileUrl(mixed $slide, mixed $x, mixed $y[, mixed $zoomlevel = null ], mixed $zstack[, mixed $sessionID = null ][, mixed $format = "jpg" ][, mixed $quality = 100 ]) : mixed
Parameters
- $slide : mixed
- $x : mixed
- $y : mixed
- $zoomlevel : mixed = null
- $zstack : mixed
- $sessionID : mixed = null
- $format : mixed = "jpg"
- $quality : mixed = 100
Return values
mixed —getUID()
Get the UID (unique identifier) for a specific slide
public
static getUID(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —getVersionInfo()
Get version info from PMA.core instance running at $pmacoreURL
public
static getVersionInfo([mixed $pmacoreURL = null ]) : mixed
Parameters
- $pmacoreURL : mixed = null
Return values
mixed —getZoomlevelsDict()
Obtain a dictionary with the number of tiles per zoomlevel.
public
static getZoomlevelsDict(mixed $slideRef[, mixed $sessionID = null ], mixed $minNumberOfTiles) : mixed
Information is returned as (x, y, n) tupels per zoomlevel, with x = number of horizontal tiles, y = number of vertical tiles, n = total number of tiles at specified zoomlevel (x * y) Use min_number_of_tiles argument to specify that you're only interested in zoomlevels that include at lease a given number of tiles
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
- $minNumberOfTiles : mixed
Return values
mixed —isFluorescent()
Determine whether a slide is a fluorescent image or not
public
static isFluorescent(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —isLite()
See if there's a PMA.core.lite or PMA.core instance running at $pmacoreURL
public
static isLite([mixed $pmacoreURL = null ]) : mixed
Parameters
- $pmacoreURL : mixed = null
Return values
mixed —isMultiLayer()
Determine whether a slide contains multiple (stacked) layers or not
public
static isMultiLayer(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —isZStack()
Determine whether a slide is a z-stack or not
public
static isZStack(mixed $slideRef[, mixed $sessionID = null ]) : mixed
Parameters
- $slideRef : mixed
- $sessionID : mixed = null
Return values
mixed —ping()
Validates a sessionID
public
static ping(mixed $pmacoreURL, mixed $sessionID) : mixed
Parameters
- $pmacoreURL : mixed
- $sessionID : mixed
Return values
mixed —registerSession()
public
static registerSession(mixed $pmacoreURL, mixed $sessionID) : mixed
Parameters
- $pmacoreURL : mixed
- $sessionID : mixed
Return values
mixed —searchSlides()
Search for slides or directories using the pattern
public
static searchSlides(mixed $startDir, mixed $pattern[, mixed $sessionID = null ]) : mixed
Parameters
- $startDir : mixed
- $pattern : mixed
- $sessionID : mixed = null
Return values
mixed —setDebugFlag()
public
static setDebugFlag(mixed $flag) : mixed
Parameters
- $flag : mixed
Return values
mixed —storePmaHostForSessionID()
Set pma_host for sessionID
public
static storePmaHostForSessionID(mixed $pma_host, mixed $sessionID) : mixed
Parameters
- $pma_host : mixed
- $sessionID : mixed
Return values
mixed —upload()
Upload a slide to a PMA.core server
public
static upload(mixed $localSlide, mixed $targetFolder, mixed $targetPmaCoresessionID) : mixed
Parameters
- $localSlide : mixed
- $targetFolder : mixed
- $targetPmaCoresessionID : mixed
Return values
mixed —whoAmI()
return information about the current user (associated with the PMA.core SessionID)
public
static whoAmI([mixed $sessionID = null ]) : mixed
Parameters
- $sessionID : mixed = null
Return values
mixed —_pma_api_url()
Internal use only
private
static _pma_api_url([mixed $sessionID = None ]) : mixed
Parameters
- $sessionID : mixed = None
Return values
mixed —_pma_first_session_id()
Internal use only
private
static _pma_first_session_id() : mixed
Return values
mixed —_pma_is_lite()
Internal use only
private
static _pma_is_lite([mixed $pmacoreURL = null ]) : mixed
Parameters
- $pmacoreURL : mixed = null
Return values
mixed —_pma_query_url()
Internal use only
private
static _pma_query_url([mixed $sessionID = None ]) : mixed
Parameters
- $sessionID : mixed = None
Return values
mixed —_pma_transfer_url()
Internal use only
private
static _pma_transfer_url([mixed $sessionID = None ]) : mixed
Parameters
- $sessionID : mixed = None
Return values
mixed —progress()
private
static progress(mixed $resource, mixed $download_size, mixed $downloaded, mixed $upload_size, mixed $uploaded) : mixed
Parameters
- $resource : mixed
- $download_size : mixed
- $downloaded : mixed
- $upload_size : mixed
- $uploaded : mixed
Return values
mixed —progressUpload()
private
static progressUpload(mixed $resource, mixed $download_size, mixed $downloaded, mixed $upload_size, mixed $uploaded) : mixed
Parameters
- $resource : mixed
- $download_size : mixed
- $downloaded : mixed
- $upload_size : mixed
- $uploaded : mixed