Class/Object

com.johnsnowlabs.nlp.annotators.ocr

PositionFinder

Related Docs: object PositionFinder | package ocr

Permalink

class PositionFinder extends Model[PositionFinder] with RawAnnotator[PositionFinder]

Linear Supertypes
RawAnnotator[PositionFinder], HasOutputAnnotationCol, HasInputAnnotationCols, HasOutputAnnotatorType, ParamsAndFeaturesWritable, HasFeatures, DefaultParamsWritable, MLWritable, Model[PositionFinder], Transformer, PipelineStage, Logging, Params, Serializable, Serializable, Identifiable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PositionFinder
  2. RawAnnotator
  3. HasOutputAnnotationCol
  4. HasInputAnnotationCols
  5. HasOutputAnnotatorType
  6. ParamsAndFeaturesWritable
  7. HasFeatures
  8. DefaultParamsWritable
  9. MLWritable
  10. Model
  11. Transformer
  12. PipelineStage
  13. Logging
  14. Params
  15. Serializable
  16. Serializable
  17. Identifiable
  18. AnyRef
  19. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PositionFinder()

    Permalink
  2. new PositionFinder(uid: String)

    Permalink

Type Members

  1. type AnnotatorType = String

    Permalink
    Definition Classes
    HasOutputAnnotatorType

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def $[T](param: Param[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  4. def $$[T](feature: StructFeature[T]): T

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  5. def $$[K, V](feature: MapFeature[K, V]): Map[K, V]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  6. def $$[T](feature: SetFeature[T]): Set[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  7. def $$[T](feature: ArrayFeature[T]): Array[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  8. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. final def checkSchema(schema: StructType, inputAnnotatorType: String): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  11. final def clear(param: Param[_]): PositionFinder.this.type

    Permalink
    Definition Classes
    Params
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def copy(extra: ParamMap): PositionFinder

    Permalink

    requirement for annotators copies

    requirement for annotators copies

    Definition Classes
    RawAnnotator → Model → Transformer → PipelineStage → Params
  14. def copyValues[T <: Params](to: T, extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  15. final def defaultCopy[T <: Params](extra: ParamMap): T

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def explainParam(param: Param[_]): String

    Permalink
    Definition Classes
    Params
  19. def explainParams(): String

    Permalink
    Definition Classes
    Params
  20. def extraValidate(structType: StructType): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  21. def extraValidateMsg: String

    Permalink

    Override for additional custom schema checks

    Override for additional custom schema checks

    Attributes
    protected
    Definition Classes
    RawAnnotator
  22. final def extractParamMap(): ParamMap

    Permalink
    Definition Classes
    Params
  23. final def extractParamMap(extra: ParamMap): ParamMap

    Permalink
    Definition Classes
    Params
  24. val features: ArrayBuffer[Feature[_, _, _]]

    Permalink
    Definition Classes
    HasFeatures
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def get[T](feature: StructFeature[T]): Option[T]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  27. def get[K, V](feature: MapFeature[K, V]): Option[Map[K, V]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  28. def get[T](feature: SetFeature[T]): Option[Set[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  29. def get[T](feature: ArrayFeature[T]): Option[Array[T]]

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  30. final def get[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  31. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def getDefault[T](param: Param[T]): Option[T]

    Permalink
    Definition Classes
    Params
  33. def getInputCols: Array[String]

    Permalink

    returns

    input annotations columns currently used

    Definition Classes
    HasInputAnnotationCols
  34. def getMatchingWindow: Int

    Permalink
  35. final def getOrDefault[T](param: Param[T]): T

    Permalink
    Definition Classes
    Params
  36. final def getOutputCol: String

    Permalink

    Gets annotation column name going to generate

    Gets annotation column name going to generate

    Definition Classes
    HasOutputAnnotationCol
  37. def getPageMatrixCol: String

    Permalink
  38. def getParam(paramName: String): Param[Any]

    Permalink
    Definition Classes
    Params
  39. def getWindowPageTolerance: Boolean

    Permalink
  40. final def hasDefault[T](param: Param[T]): Boolean

    Permalink
    Definition Classes
    Params
  41. def hasParam(paramName: String): Boolean

    Permalink
    Definition Classes
    Params
  42. def hasParent: Boolean

    Permalink
    Definition Classes
    Model
  43. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  44. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  45. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  46. val inputAnnotatorTypes: Array[AnnotatorType]

    Permalink

    A Tokenizer could require only for now a SentenceDetector annotator

    A Tokenizer could require only for now a SentenceDetector annotator

    Definition Classes
    PositionFinderHasInputAnnotationCols
  47. final val inputCols: StringArrayParam

    Permalink

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    columns that contain annotations necessary to run this annotator AnnotatorType is used both as input and output columns if not specified

    Attributes
    protected
    Definition Classes
    HasInputAnnotationCols
  48. final def isDefined(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  49. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  50. final def isSet(param: Param[_]): Boolean

    Permalink
    Definition Classes
    Params
  51. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  52. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  53. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  54. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  55. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  56. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  57. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  58. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  59. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  60. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  61. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  63. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  64. val matchingWindow: IntParam

    Permalink
  65. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  66. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  67. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  68. def onWrite(path: String, spark: SparkSession): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ParamsAndFeaturesWritable
  69. val outputAnnotatorType: AnnotatorType

    Permalink
    Definition Classes
    PositionFinderHasOutputAnnotatorType
  70. final val outputCol: Param[String]

    Permalink
    Attributes
    protected
    Definition Classes
    HasOutputAnnotationCol
  71. val pageMatrixCol: Param[String]

    Permalink
  72. lazy val params: Array[Param[_]]

    Permalink
    Definition Classes
    Params
  73. var parent: Estimator[PositionFinder]

    Permalink
    Definition Classes
    Model
  74. def save(path: String): Unit

    Permalink
    Definition Classes
    MLWritable
    Annotations
    @Since( "1.6.0" ) @throws( ... )
  75. def set[T](feature: StructFeature[T], value: T): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  76. def set[K, V](feature: MapFeature[K, V], value: Map[K, V]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  77. def set[T](feature: SetFeature[T], value: Set[T]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  78. def set[T](feature: ArrayFeature[T], value: Array[T]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  79. final def set(paramPair: ParamPair[_]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  80. final def set(param: String, value: Any): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  81. final def set[T](param: Param[T], value: T): PositionFinder.this.type

    Permalink
    Definition Classes
    Params
  82. def setDefault[T](feature: StructFeature[T], value: () ⇒ T): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  83. def setDefault[K, V](feature: MapFeature[K, V], value: () ⇒ Map[K, V]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  84. def setDefault[T](feature: SetFeature[T], value: () ⇒ Set[T]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  85. def setDefault[T](feature: ArrayFeature[T], value: () ⇒ Array[T]): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    HasFeatures
  86. final def setDefault(paramPairs: ParamPair[_]*): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  87. final def setDefault[T](param: Param[T], value: T): PositionFinder.this.type

    Permalink
    Attributes
    protected
    Definition Classes
    Params
  88. final def setInputCols(value: String*): PositionFinder.this.type

    Permalink
    Definition Classes
    HasInputAnnotationCols
  89. final def setInputCols(value: Array[String]): PositionFinder.this.type

    Permalink

    Overrides required annotators column if different than default

    Overrides required annotators column if different than default

    Definition Classes
    HasInputAnnotationCols
  90. def setMatchingWindow(value: Int): PositionFinder.this.type

    Permalink
  91. final def setOutputCol(value: String): PositionFinder.this.type

    Permalink

    Overrides annotation column name when transforming

    Overrides annotation column name when transforming

    Definition Classes
    HasOutputAnnotationCol
  92. def setPageMatrixCol(value: String): PositionFinder.this.type

    Permalink
  93. def setParent(parent: Estimator[PositionFinder]): PositionFinder

    Permalink
    Definition Classes
    Model
  94. def setWindowPageTolerance(value: Boolean): PositionFinder.this.type

    Permalink
  95. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  96. def toString(): String

    Permalink
    Definition Classes
    Identifiable → AnyRef → Any
  97. def transform(dataset: Dataset[_]): DataFrame

    Permalink
    Definition Classes
    PositionFinder → Transformer
  98. def transform(dataset: Dataset[_], paramMap: ParamMap): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" )
  99. def transform(dataset: Dataset[_], firstParamPair: ParamPair[_], otherParamPairs: ParamPair[_]*): DataFrame

    Permalink
    Definition Classes
    Transformer
    Annotations
    @Since( "2.0.0" ) @varargs()
  100. final def transformSchema(schema: StructType): StructType

    Permalink

    requirement for pipeline transformation validation.

    requirement for pipeline transformation validation. It is called on fit()

    Definition Classes
    RawAnnotator → PipelineStage
  101. def transformSchema(schema: StructType, logging: Boolean): StructType

    Permalink
    Attributes
    protected
    Definition Classes
    PipelineStage
    Annotations
    @DeveloperApi()
  102. val uid: String

    Permalink
    Definition Classes
    PositionFinder → Identifiable
  103. def validate(schema: StructType): Boolean

    Permalink

    takes a Dataset and checks to see if all the required annotation types are present.

    takes a Dataset and checks to see if all the required annotation types are present.

    schema

    to be validated

    returns

    True if all the required types are present, else false

    Attributes
    protected
    Definition Classes
    RawAnnotator
  104. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  105. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. val windowPageTolerance: BooleanParam

    Permalink
  108. def wrapColumnMetadata(col: Column): Column

    Permalink
    Attributes
    protected
    Definition Classes
    RawAnnotator
  109. def write: MLWriter

    Permalink
    Definition Classes
    ParamsAndFeaturesWritable → DefaultParamsWritable → MLWritable

Inherited from RawAnnotator[PositionFinder]

Inherited from HasOutputAnnotationCol

Inherited from HasInputAnnotationCols

Inherited from HasOutputAnnotatorType

Inherited from ParamsAndFeaturesWritable

Inherited from HasFeatures

Inherited from DefaultParamsWritable

Inherited from MLWritable

Inherited from Model[PositionFinder]

Inherited from Transformer

Inherited from PipelineStage

Inherited from Logging

Inherited from Params

Inherited from Serializable

Inherited from Serializable

Inherited from Identifiable

Inherited from AnyRef

Inherited from Any

Ungrouped