GarmentMeasurements

GarmentMeasurements is a PCA body model with an FBX-derived skeleton and skinning, intended for garment measurement workflows.

Setup

GarmentMeasurements downloads its preprocessed asset from https://huggingface.co/datasets/abcamiletto/body-models-assets on first use. To prefetch and save the path:

# Download the preprocessed GarmentMeasurements body-model asset.
body-models download garment-measurements

API

body_models.bodies.garment_measurements.numpy.GarmentMeasurements

GarmentMeasurements(
    model_path=None, *, rotation_type="axis_angle", kernel="numpy"
)

Bases: BodyModel

GarmentMeasurements PCA body model with FBX-derived skeleton/skinning.

Initialize the GarmentMeasurements model.

PARAMETER	DESCRIPTION
model_path	Path to model assets, or the default assets when omitted. TYPE: Path | str | None DEFAULT: None
rotation_type	Rotation representation expected by pose inputs. TYPE: RotationType DEFAULT: 'axis_angle'
kernel	Backend kernel used for forward evaluation. TYPE: Literal['numpy', 'numba'] DEFAULT: 'numpy'

METHOD	DESCRIPTION
forward_vertices	Compute posed mesh vertices.
forward_skeleton	Compute posed joint transforms.
prepare_identity	Precompute shape-dependent state for repeated forward passes.
prepare_pose	Precompute pose-dependent state for repeated forward passes.
joint_index	Resolve a standard joint to this model's native joint index.
prepare_skinning	Pack prepared model state into renderer-ready skinning inputs.

ATTRIBUTE	DESCRIPTION
common_joints	Common anatomical joints mapped to this model's native joint names. TYPE: Mapping[Joint, str]

Source code in src/body_models/bodies/garment_measurements/numpy.py

def __init__(
    self,
    model_path: Path | str | None = None,
    *,
    rotation_type: RotationType = "axis_angle",
    kernel: Literal["numpy", "numba"] = "numpy",
) -> None:
    """Initialize the GarmentMeasurements model.

    Args:
        model_path: Path to model assets, or the default assets when omitted.
        rotation_type: Rotation representation expected by pose inputs.
        kernel: Backend kernel used for forward evaluation.
    """
    if rotation_type not in VALID_ROTATION_TYPES:
        raise ValueError(f"Invalid rotation_type: {rotation_type}")
    if kernel not in self.kernels:
        raise ValueError(f"Invalid kernel: {kernel}")

    self.weights = load_model_data(get_model_path(model_path), dtype=np.float32)
    self.rotation_type = rotation_type
    self.num_rot_dims = 2 if rotation_type in ("matrix", "rotmat") else 1
    self._kernel = _get_kernel(kernel)

common_joints property

common_joints

Common anatomical joints mapped to this model's native joint names.

forward_vertices

forward_vertices(
    body_pose,
    head_pose,
    hand_pose,
    pelvis_rotation,
    global_rotation=None,
    global_translation=None,
    vertex_indices=None,
    *,
    shape=None,
    identity=None,
)

Compute posed mesh vertices.

PARAMETER	DESCRIPTION
shape	Shape coefficients. TYPE: Float[ndarray, '*batch C'] | None DEFAULT: None
body_pose	Local body joint rotations. TYPE: Float[ndarray, '*batch 25 N'] | Float[ndarray, '*batch 25 3 3']
head_pose	Local head and facial joint rotations. TYPE: Float[ndarray, '*batch 3 N'] | Float[ndarray, '*batch 3 3 3']
hand_pose	Local hand joint rotations. TYPE: Float[ndarray, '*batch 30 N'] | Float[ndarray, '*batch 30 3 3']
pelvis_rotation	Root pelvis rotation. TYPE: Float[ndarray, '*batch N'] | Float[ndarray, '*batch 3 3']
global_rotation	Global model rotation. TYPE: Float[ndarray, '*batch N'] | Float[ndarray, '*batch 3 3'] | None DEFAULT: None
global_translation	Global model translation. TYPE: Float[ndarray, '*batch 3'] | None DEFAULT: None
vertex_indices	Optional subset of vertices to return. TYPE: list[int] | None DEFAULT: None

RETURNS	DESCRIPTION
Float[ndarray, '*batch V 3']	Posed vertex positions.

Source code in src/body_models/bodies/garment_measurements/numpy.py

def forward_vertices(
    self,
    body_pose: Float[np.ndarray, "*batch 25 N"] | Float[np.ndarray, "*batch 25 3 3"],
    head_pose: Float[np.ndarray, "*batch 3 N"] | Float[np.ndarray, "*batch 3 3 3"],
    hand_pose: Float[np.ndarray, "*batch 30 N"] | Float[np.ndarray, "*batch 30 3 3"],
    pelvis_rotation: Float[np.ndarray, "*batch N"] | Float[np.ndarray, "*batch 3 3"],
    global_rotation: Float[np.ndarray, "*batch N"] | Float[np.ndarray, "*batch 3 3"] | None = None,
    global_translation: Float[np.ndarray, "*batch 3"] | None = None,
    vertex_indices: list[int] | None = None,
    *,
    shape: Float[np.ndarray, "*batch C"] | None = None,
    identity: GarmentMeasurementsIdentity | None = None,
) -> Float[np.ndarray, "*batch V 3"]:
    """Compute posed mesh vertices.

    Args:
        shape: Shape coefficients.
        body_pose: Local body joint rotations.
        head_pose: Local head and facial joint rotations.
        hand_pose: Local hand joint rotations.
        pelvis_rotation: Root pelvis rotation.
        global_rotation: Global model rotation.
        global_translation: Global model translation.
        vertex_indices: Optional subset of vertices to return.

    Returns:
        Posed vertex positions.
    """
    pose = pack_pose(np, pelvis_rotation, body_pose, head_pose, hand_pose)
    if identity is None:
        assert shape is not None
        batch_shape = pose.shape[: -(self.num_rot_dims + 1)]
        shape = np.broadcast_to(shape, (*batch_shape, shape.shape[-1]))
        identity = self.prepare_identity(shape)
    pose = self.prepare_pose(pose, identity=identity)
    return self._kernel.forward_vertices(
        weights=self.weights,
        global_rotation=global_rotation,
        global_translation=global_translation,
        vertex_indices=vertex_indices,
        rotation_type=self.rotation_type,
        rest_vertices=identity["rest_vertices"],
        skinning_transforms=pose["skinning_transforms"],
    )

forward_skeleton

forward_skeleton(
    body_pose,
    head_pose,
    hand_pose,
    pelvis_rotation,
    global_rotation=None,
    global_translation=None,
    joint_indices=None,
    *,
    shape=None,
    identity=None,
)

Compute posed joint transforms.

PARAMETER	DESCRIPTION
shape	Shape coefficients. TYPE: Float[ndarray, '*batch C'] | None DEFAULT: None
body_pose	Local body joint rotations. TYPE: Float[ndarray, '*batch 25 N'] | Float[ndarray, '*batch 25 3 3']
head_pose	Local head and facial joint rotations. TYPE: Float[ndarray, '*batch 3 N'] | Float[ndarray, '*batch 3 3 3']
hand_pose	Local hand joint rotations. TYPE: Float[ndarray, '*batch 30 N'] | Float[ndarray, '*batch 30 3 3']
pelvis_rotation	Root pelvis rotation. TYPE: Float[ndarray, '*batch N'] | Float[ndarray, '*batch 3 3']
global_rotation	Global model rotation. TYPE: Float[ndarray, '*batch N'] | Float[ndarray, '*batch 3 3'] | None DEFAULT: None
global_translation	Global model translation. TYPE: Float[ndarray, '*batch 3'] | None DEFAULT: None
joint_indices	Optional subset of joints to return. TYPE: list[int] | None DEFAULT: None

RETURNS	DESCRIPTION
Float[ndarray, '*batch J 4 4']	Joint transforms in the model hierarchy.

Source code in src/body_models/bodies/garment_measurements/numpy.py

def forward_skeleton(
    self,
    body_pose: Float[np.ndarray, "*batch 25 N"] | Float[np.ndarray, "*batch 25 3 3"],
    head_pose: Float[np.ndarray, "*batch 3 N"] | Float[np.ndarray, "*batch 3 3 3"],
    hand_pose: Float[np.ndarray, "*batch 30 N"] | Float[np.ndarray, "*batch 30 3 3"],
    pelvis_rotation: Float[np.ndarray, "*batch N"] | Float[np.ndarray, "*batch 3 3"],
    global_rotation: Float[np.ndarray, "*batch N"] | Float[np.ndarray, "*batch 3 3"] | None = None,
    global_translation: Float[np.ndarray, "*batch 3"] | None = None,
    joint_indices: list[int] | None = None,
    *,
    shape: Float[np.ndarray, "*batch C"] | None = None,
    identity: GarmentMeasurementsIdentity | None = None,
) -> Float[np.ndarray, "*batch J 4 4"]:
    """Compute posed joint transforms.

    Args:
        shape: Shape coefficients.
        body_pose: Local body joint rotations.
        head_pose: Local head and facial joint rotations.
        hand_pose: Local hand joint rotations.
        pelvis_rotation: Root pelvis rotation.
        global_rotation: Global model rotation.
        global_translation: Global model translation.
        joint_indices: Optional subset of joints to return.

    Returns:
        Joint transforms in the model hierarchy.
    """
    pose = pack_pose(np, pelvis_rotation, body_pose, head_pose, hand_pose)
    if identity is None:
        assert shape is not None
        batch_shape = pose.shape[: -(self.num_rot_dims + 1)]
        shape = np.broadcast_to(shape, (*batch_shape, shape.shape[-1]))
        identity = self.prepare_identity(shape, skip_vertices=True)
    pose = self.prepare_pose(pose, identity=identity, skip_vertices=True)
    return self._kernel.forward_skeleton(
        self.weights,
        pose["skeleton_transforms"],
        global_rotation=global_rotation,
        global_translation=global_translation,
        joint_indices=joint_indices,
        rotation_type=self.rotation_type,
    )

prepare_identity

prepare_identity(shape, skip_vertices=False)

Precompute shape-dependent state for repeated forward passes.

Source code in src/body_models/bodies/garment_measurements/numpy.py

def prepare_identity(
    self,
    shape: Float[np.ndarray, "*batch C"],
    skip_vertices: bool = False,
) -> GarmentMeasurementsIdentity:
    """Precompute shape-dependent state for repeated forward passes."""
    return self._kernel.prepare_identity(self.weights, shape, skip_vertices=skip_vertices)

prepare_pose

prepare_pose(pose, *, identity, skip_vertices=False)

Precompute pose-dependent state for repeated forward passes.

Source code in src/body_models/bodies/garment_measurements/numpy.py

def prepare_pose(
    self,
    pose: Float[np.ndarray, "*batch J N"] | Float[np.ndarray, "*batch J 3 3"],
    *,
    identity: GarmentMeasurementsIdentity,
    skip_vertices: bool = False,
) -> GarmentMeasurementsPreparedPose:
    """Precompute pose-dependent state for repeated forward passes."""
    return self._kernel.prepare_pose(
        self.weights,
        pose,
        rotation_type=self.rotation_type,
        bind_skeleton=identity["bind_skeleton"],
        local_bind_translations=identity["local_bind_translations"],
        skip_vertices=skip_vertices,
    )

joint_index

joint_index(joint)

Resolve a standard joint to this model's native joint index.

Source code in src/body_models/base.py

def joint_index(self, joint: Joint) -> int:
    """Resolve a standard joint to this model's native joint index."""
    if not isinstance(joint, Joint):
        raise TypeError("joint_index() expects a body_models.Joint; use joint_names.index(...) for native names.")
    try:
        native_name = self.common_joints[joint]
    except KeyError as exc:
        raise KeyError(f"{self.__class__.__name__} has no standard joint {joint.value!r}") from exc
    return self.joint_names.index(native_name)

prepare_skinning

prepare_skinning(*, identity, pose)

Pack prepared model state into renderer-ready skinning inputs.

Source code in src/body_models/base.py

def prepare_skinning(self, *, identity: Mapping[str, Any], pose: Mapping[str, Any]) -> SkinningPayload:
    """Pack prepared model state into renderer-ready skinning inputs."""
    if self.is_rigid_body:
        raise NotImplementedError(f"{self.__class__.__name__} is rigid and does not support skinning.")

    skinning: SkinningPayload = {
        "rest_vertices": identity["rest_vertices"],
        "skinning_transforms": pose["skinning_transforms"],
        "skin_weights": self.skin_weights,
        "faces": self.faces,
    }
    if "pose_offsets" in pose:
        skinning["pose_offsets"] = pose["pose_offsets"]
    return skinning