Improved comment and typing information

This commit is contained in:
Colin Basnett
2022-11-01 11:32:50 -07:00
parent b6ef3dda44
commit 4181a15d0e
2 changed files with 10 additions and 5 deletions

View File

@@ -6,7 +6,7 @@ from ..data import *
"""
Note that keys are not stored within the Psa object.
Use the PsaReader::get_sequence_keys to get a the keys for a sequence.
Use the PsaReader::get_sequence_keys to get the keys for a sequence.
"""
@@ -60,5 +60,5 @@ class Psa(object):
def __init__(self):
self.bones: List[Psa.Bone] = []
self.sequences: typing.OrderedDict[Psa.Sequence] = OrderedDict()
self.sequences: typing.OrderedDict[str, Psa.Sequence] = OrderedDict()
self.keys: List[Psa.Key] = []

View File

@@ -25,7 +25,12 @@ class PsaReader(object):
def sequences(self):
return self.psa.sequences
def read_sequence_data_matrix(self, sequence_name: str):
def read_sequence_data_matrix(self, sequence_name: str) -> np.ndarray:
"""
Reads and returns the data matrix for the given sequence.
@param sequence_name: The name of the sequence.
@return: An FxBx7 matrix where F is the number of frames, B is the number of bones.
"""
sequence = self.psa.sequences[sequence_name]
keys = self.read_sequence_keys(sequence_name)
bone_count = len(self.bones)
@@ -41,8 +46,8 @@ class PsaReader(object):
"""
Reads and returns the key data for a sequence.
:param sequence_name: The name of the sequence.
:return: A list of Psa.Keys.
@param sequence_name: The name of the sequence.
@return: A list of Psa.Keys.
"""
# Set the file reader to the beginning of the keys data
sequence = self.psa.sequences[sequence_name]