SessionStatus Class

  • Reference
Package:
com.microsoft.azure.spatialanchors
  • java.lang.Object
    • com.microsoft.azure.spatialanchors.SessionStatus

public class SessionStatus

This type describes the status of spatial data processing.

Method Summary

Modifier and Type Method and Description
void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

float getReadyForCreateProgress()

Gets the level of data sufficiency for a successful operation. This value will be in the [0;1) range when data is insufficient; 1 when data is sufficient for success and greater than 1 when conditions are better than minimally sufficient.

float getRecommendedForCreateProgress()

Gets the ratio of data available to recommended data to create an anchor. This value will be in the [0;1) range when data is below the recommended threshold; 1 and greater when the recommended amount of data has been gathered for a creation operation.

int getSessionCreateHash()

A hash value that can be used to know when environment data that contributes to a creation operation has changed to included the latest input data. If the hash value does not change after new frames were added to the session, then those frames were not deemed as sufficientlyy different from existing environment data and disgarded. This value may be 0 (and should be ignored) for platforms that don't feed frames individually.

int getSessionLocateHash()

A hash value that can be used to know when environment data that contributes to a locate operation has changed to included the latest input data. If the hash value does not change after new frames were added to the session, then those frames were not deemed as sufficiency different from existing environment data and disgarded. This value may be 0 (and should be ignored) for platforms that don't feed frames individually.

SessionUserFeedback getUserFeedback()

Feedback that can be provided to user about data processing status.

Method Details

finalize

protected void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

getReadyForCreateProgress

public float getReadyForCreateProgress()

Gets the level of data sufficiency for a successful operation. This value will be in the [0;1) range when data is insufficient; 1 when data is sufficient for success and greater than 1 when conditions are better than minimally sufficient.

getRecommendedForCreateProgress

public float getRecommendedForCreateProgress()

Gets the ratio of data available to recommended data to create an anchor. This value will be in the [0;1) range when data is below the recommended threshold; 1 and greater when the recommended amount of data has been gathered for a creation operation.

getSessionCreateHash

public int getSessionCreateHash()

A hash value that can be used to know when environment data that contributes to a creation operation has changed to included the latest input data. If the hash value does not change after new frames were added to the session, then those frames were not deemed as sufficientlyy different from existing environment data and disgarded. This value may be 0 (and should be ignored) for platforms that don't feed frames individually.

getSessionLocateHash

public int getSessionLocateHash()

A hash value that can be used to know when environment data that contributes to a locate operation has changed to included the latest input data. If the hash value does not change after new frames were added to the session, then those frames were not deemed as sufficiency different from existing environment data and disgarded. This value may be 0 (and should be ignored) for platforms that don't feed frames individually.

getUserFeedback

public SessionUserFeedback getUserFeedback()

Feedback that can be provided to user about data processing status.

Applies to