DSLineSegmentsUnit

The DSLineSegmentsUnit class extends the DSIntermediateResultUnit class and represents a unit of intermediate result specifically for line segments.

Definition

Assembly: DynamsoftCore.framework

• Objective-C
• Swift

1. @interface DSLineSegmentsUnit: DSIntermediateResultUnit
   

2. class LineSegmentsUnit : IntermediateResultUnit
   

Methods

Method	Description
getLineSegments	Gets an array of DSLineSegment objects, each representing a segment of a line detected within the image.
getCount	Returns the number of line segments.
getLineSegment	Returns the line segment at the specified index.
removeAllLineSegments	Removes all line segments.
removeLineSegment	Removes the line segment at the specified index.
addLineSegment	Adds a line segment.
setLineSegment	Sets a line segment.

Inherited Methods

The following methods are inherited from class DSIntermediateResultUnit.

Method	Description
getHashId	Gets the hash ID of the unit. The hash ID is the unique identifier for the intermediate result unit.
getOriginalImageHashId	Gets the hash ID of the original image associated with this unit.
getOriginalImageTag	Gets the tag associated with the original image.
getType	Gets the type of the intermediate result unit, defined by the enumeration IntermediateResultUnitType.
getTransformMatrix	Gets the transformation matrix via DSTransformMatrixType.
clone	Creates a copy of the intermediate result unit.
replace	Replaces the content of the intermediate result unit.

getLineSegments

Get an array of DSLineSegment objects, each representing a segment of a line detected within the image.

• Objective-C
• Swift

1. -(nullable NSArray<DSLineSegment*>*)getLineSegments;
   

2. func getLineSegments() -> [LineSegment]?
   

Return Value

An array of DSLineSegment objects.

getCount

Returns the number of line segments.

• Objective-C
• Swift

1. -(NSInteger)getCount;
   

2. func getCount() -> Int
   

Return Value

Returns the number of line segments.

getLineSegment

Returns the line segment at the specified index.

• Objective-C
• Swift

1. -(nullable DSLineSegment *)getLineSegment:(NSInteger)index;
   

2. func getLineSegment(_ index: Int) -> LineSegment?
   

Parameters

index: The index of the line segment.

Return Value

Returns the line segment at the specified index.

removeAllLineSegments

Removes all line segments.

• Objective-C
• Swift

1. -(void)removeAllLineSegments;
   

2. func removeAllLineSegments()
   

removeLineSegment

Removes the line segment at the specified index.

• Objective-C
• Swift

1. -(NSInteger)removeLineSegment:(NSInteger)index;
   

2. func removeLineSegment(_ index: Int) -> Int
   

Parameters

index: The index of the line segment.

Return Value

Returns the ErrorCode if failed. Otherwise, returns 0.

addLineSegment

Adds a line segment.

• Objective-C
• Swift

1. -(NSInteger)addLineSegment:(DSLineSegment *)line
   matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
   

2. func addLineSegment(_ line: LineSegment, matrixToOriginalImage: CGAffineTransform) -> Int
   

Parameters

line: A DSLineSegment object as the line segment.

matrixToOriginalImage: A CGAffineTransform object as the matrix to original image.

Return Value

Returns the ErrorCode if failed. Otherwise, returns 0.

setLineSegment

Sets a line segment.

• Objective-C
• Swift

1. -(NSInteger)setLineSegment:(NSInteger)index
                     line:(DSLineSegment *)line
   matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
   

2. func setLineSegment(_ index: Int, line: LineSegment, matrixToOriginalImage: CGAffineTransform) -> Int
   

Parameters

index: The index of the line segment.

line: A DSLineSegment object as the line segment.

matrixToOriginalImage: A CGAffineTransform object as the matrix to original image.

Return Value

Returns the ErrorCode if failed. Otherwise, returns 0.