Package org.biojava.nbio.structure.io.density

Class EmdbEntryInfo

java.lang.Object

org.biojava.nbio.structure.io.density.EmdbEntryInfo

public class EmdbEntryInfo
extends Object

The few facts about an EMDB entry's primary map that matter when fetching and displaying it.

Since:

7.3.0

Author:

Amr ALHOSSARY

Constructor Summary

Constructors

Constructor	Description
EmdbEntryInfo(String emdbId, Double recommendedContourLevel, Double sigma, Long mapSizeBytes)

Method Summary

Modifier and Type	Method	Description
String	getEmdbId()
Long	getMapSizeBytes()
Double	getRecommendedContourLevel()	The contour level the depositors recommend, in absolute map units.
Double	getSigma()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EmdbEntryInfo

public EmdbEntryInfo(String emdbId,
 Double recommendedContourLevel,
 Double sigma,
 Long mapSizeBytes)

Parameters:

emdbId - the entry identifier, canonical form

recommendedContourLevel - the author-recommended contour level in absolute map units, or null

sigma - the RMS deviation of the map values, or null

mapSizeBytes - the size of the primary map file, or null

Method Details

getEmdbId

public String getEmdbId()

Returns:

the entry identifier in canonical EMD-1234 form

getRecommendedContourLevel

public Double getRecommendedContourLevel()

The contour level the depositors recommend, in absolute map units. EM maps are conventionally displayed at this level rather than at a multiple of sigma, so it is the right default for a viewer.

Returns:

the level, or null if the entry does not state one

getSigma

public Double getSigma()

Returns:

the RMS deviation of the map values, which converts between absolute and sigma-relative contour levels, or null if unknown

getMapSizeBytes

public Long getMapSizeBytes()

Returns:

the size of the full primary map in bytes, or null if unknown. Used to decline a download before it starts.

toString

public String toString()

Overrides:

toString in class Object