-
Notifications
You must be signed in to change notification settings - Fork 47
/
ScaleConfig.kt
342 lines (299 loc) · 14 KB
/
ScaleConfig.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
/*
* Copyright (c) 2019. JetBrains s.r.o.
* Use of this source code is governed by the MIT license that can be found in the LICENSE file.
*/
package org.jetbrains.letsPlot.core.spec.config
import org.jetbrains.letsPlot.commons.formatting.string.StringFormat
import org.jetbrains.letsPlot.commons.formatting.string.StringFormat.FormatType.DATETIME_FORMAT
import org.jetbrains.letsPlot.commons.values.Color
import org.jetbrains.letsPlot.commons.values.Colors
import org.jetbrains.letsPlot.core.plot.base.Aes
import org.jetbrains.letsPlot.core.plot.base.ScaleMapper
import org.jetbrains.letsPlot.core.plot.base.scale.transform.DateTimeBreaksGen
import org.jetbrains.letsPlot.core.plot.base.scale.transform.TimeBreaksGen
import org.jetbrains.letsPlot.core.plot.base.scale.transform.Transforms
import org.jetbrains.letsPlot.core.plot.builder.scale.*
import org.jetbrains.letsPlot.core.plot.builder.scale.mapper.ShapeMapper
import org.jetbrains.letsPlot.core.plot.builder.scale.provider.*
import org.jetbrains.letsPlot.core.spec.Option
import org.jetbrains.letsPlot.core.spec.Option.Scale.AES
import org.jetbrains.letsPlot.core.spec.Option.Scale.BREAKS
import org.jetbrains.letsPlot.core.spec.Option.Scale.CHROMA
import org.jetbrains.letsPlot.core.spec.Option.Scale.COLORS
import org.jetbrains.letsPlot.core.spec.Option.Scale.DIRECTION
import org.jetbrains.letsPlot.core.spec.Option.Scale.END
import org.jetbrains.letsPlot.core.spec.Option.Scale.EXPAND
import org.jetbrains.letsPlot.core.spec.Option.Scale.FORMAT
import org.jetbrains.letsPlot.core.spec.Option.Scale.GUIDE
import org.jetbrains.letsPlot.core.spec.Option.Scale.HIGH
import org.jetbrains.letsPlot.core.spec.Option.Scale.HUE_RANGE
import org.jetbrains.letsPlot.core.spec.Option.Scale.LABELS
import org.jetbrains.letsPlot.core.spec.Option.Scale.LABLIM
import org.jetbrains.letsPlot.core.spec.Option.Scale.LIMITS
import org.jetbrains.letsPlot.core.spec.Option.Scale.LOW
import org.jetbrains.letsPlot.core.spec.Option.Scale.LUMINANCE
import org.jetbrains.letsPlot.core.spec.Option.Scale.MAX_SIZE
import org.jetbrains.letsPlot.core.spec.Option.Scale.MID
import org.jetbrains.letsPlot.core.spec.Option.Scale.MIDPOINT
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_BREWER
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_CMAP
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_GRADIENT
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_GRADIENT2
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_GRADIENTN
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_GREY
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.COLOR_HUE
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.IDENTITY
import org.jetbrains.letsPlot.core.spec.Option.Scale.MapperKind.SIZE_AREA
import org.jetbrains.letsPlot.core.spec.Option.Scale.NAME
import org.jetbrains.letsPlot.core.spec.Option.Scale.NA_VALUE
import org.jetbrains.letsPlot.core.spec.Option.Scale.OUTPUT_VALUES
import org.jetbrains.letsPlot.core.spec.Option.Scale.PALETTE
import org.jetbrains.letsPlot.core.spec.Option.Scale.PALETTE_TYPE
import org.jetbrains.letsPlot.core.spec.Option.Scale.RANGE
import org.jetbrains.letsPlot.core.spec.Option.Scale.SCALE_MAPPER_KIND
import org.jetbrains.letsPlot.core.spec.Option.Scale.SHAPE_SOLID
import org.jetbrains.letsPlot.core.spec.Option.Scale.START
import org.jetbrains.letsPlot.core.spec.Option.Scale.START_HUE
import org.jetbrains.letsPlot.core.spec.Option.Scale.Viridis
import org.jetbrains.letsPlot.core.spec.Option.TransformName
import org.jetbrains.letsPlot.core.spec.conversion.AesOptionConversion
import org.jetbrains.letsPlot.core.spec.conversion.TypedContinuousIdentityMappers
/**
* @param <T> - target aesthetic type of the configured scale
*/
class ScaleConfig<T> constructor(
val aes: Aes<T>,
options: Map<String, Any>,
private val aopConversion: AesOptionConversion
) : OptionsAccessor(options) {
private fun enforceDiscreteDomain(): Boolean {
// Discrete domain if
// - aes mapping is annotated with 'is_discrete';
// - scale_x_discrete, scale_y_discrete.
return getBoolean(Option.Scale.DISCRETE_DOMAIN)
}
fun createMapperProvider(): MapperProvider<T> {
var mapperProvider: MapperProvider<*> = DefaultMapperProvider[aes]
val naValue: T = when {
has(NA_VALUE) -> getValue(aes, NA_VALUE, aopConversion)!!
else -> DefaultNaValue[aes]
}
// all 'manual' scales
if (has(OUTPUT_VALUES)) {
val outputValues = getList(OUTPUT_VALUES)
val mapperOutputValues = aopConversion.applyToList(aes, outputValues)
mapperProvider = DefaultMapperProviderUtil.createWithDiscreteOutput(mapperOutputValues, naValue)
}
if (aes == Aes.SHAPE) {
val solid = get(SHAPE_SOLID)
// False - show only hollow shapes, otherwise - all (default)
if (solid is Boolean && solid == false) {
mapperProvider = DefaultMapperProviderUtil.createWithDiscreteOutput(
ShapeMapper.hollowShapes(), ShapeMapper.NA_VALUE
)
}
} else if (aes == Aes.ALPHA && has(RANGE)) {
mapperProvider = AlphaMapperProvider(getRange(RANGE), (naValue as Double))
} else if (aes == Aes.SIZE && has(RANGE)) {
mapperProvider = SizeMapperProvider(getRange(RANGE), (naValue as Double))
} else if (aes == Aes.LINEWIDTH && has(RANGE)) {
mapperProvider = LinewidthMapperProvider(getRange(RANGE), (naValue as Double))
} else if (aes == Aes.STROKE && has(RANGE)) {
mapperProvider = StrokeMapperProvider(getRange(RANGE), (naValue as Double))
}
val scaleMapperKind = getString(SCALE_MAPPER_KIND) ?: if (
!has(OUTPUT_VALUES) &&
enforceDiscreteDomain() &&
Aes.isColor(aes)
) {
// Default palette type for discrete colors
COLOR_BREWER
} else {
null
}
when (scaleMapperKind) {
null -> {} // Nothing
IDENTITY ->
mapperProvider = createIdentityMapperProvider(aes, naValue, aopConversion)
COLOR_GRADIENT ->
mapperProvider = ColorGradientMapperProvider(
getColor(LOW, aopConversion),
getColor(HIGH, aopConversion),
(naValue as Color)
)
COLOR_GRADIENT2 ->
mapperProvider = ColorGradient2MapperProvider(
getColor(LOW, aopConversion),
getColor(MID, aopConversion),
getColor(HIGH, aopConversion),
getDouble(MIDPOINT), naValue as Color
)
COLOR_GRADIENTN ->
mapperProvider = ColorGradientnMapperProvider(
getStringList(COLORS).map(Colors::parseColor),
naValue as Color
)
COLOR_HUE ->
mapperProvider = ColorHueMapperProvider(
hueRange = getRangeOrNull(HUE_RANGE) ?: ColorHueMapperProvider.DEF_HUE_RANGE,
chroma = (getDouble(CHROMA) ?: ColorHueMapperProvider.DEF_CHROMA),
luminance = (getDouble(LUMINANCE) ?: ColorHueMapperProvider.DEF_LUMINANCE),
startHue = getDouble(START_HUE) ?: ColorHueMapperProvider.DEF_START_HUE,
reversed = getDouble(DIRECTION)?.let { it < 0 } ?: false,
naValue = naValue as Color
)
COLOR_GREY ->
mapperProvider = GreyscaleLightnessMapperProvider(
getDouble(START) ?: GreyscaleLightnessMapperProvider.DEF_START,
getDouble(END) ?: GreyscaleLightnessMapperProvider.DEF_END,
naValue as Color
)
COLOR_BREWER ->
mapperProvider = ColorBrewerMapperProvider(
getString(PALETTE_TYPE),
get(PALETTE),
getDouble(DIRECTION),
naValue as Color
)
COLOR_CMAP ->
mapperProvider = ColormapMapperProvider(
getString(Viridis.CMAP_NAME),
getDouble(Viridis.ALPHA),
getDouble(Viridis.BEGIN),
getDouble(Viridis.END),
getDouble(Viridis.DIRECTION),
naValue as Color
)
SIZE_AREA ->
mapperProvider = SizeAreaMapperProvider(
getDouble(MAX_SIZE),
naValue as Double
)
else ->
throw IllegalArgumentException("Aes '" + aes.name + "' - unexpected scale mapper kind: '" + scaleMapperKind + "'")
}
@Suppress("UNCHECKED_CAST")
return mapperProvider as MapperProvider<T>
}
fun createScaleProvider(): ScaleProvider {
return createScaleProviderBuilder().build()
}
fun createScaleProviderBuilder(): ScaleProviderBuilder<T> {
val discreteDomain = enforceDiscreteDomain()
val reverse = getBoolean(Option.Scale.DISCRETE_DOMAIN_REVERSE)
val b = ScaleProviderBuilder(aes)
b.discreteDomain(discreteDomain)
b.discreteDomainReverse(reverse)
if (getBoolean(Option.Scale.DATE_TIME)) {
val dateTimeFormatter = getString(FORMAT)?.let { pattern ->
val stringFormat = StringFormat.forOneArg(pattern, type = DATETIME_FORMAT)
return@let { value: Any -> stringFormat.format(value) }
}
b.breaksGenerator(DateTimeBreaksGen(dateTimeFormatter))
} else if (getBoolean(Option.Scale.TIME)) {
b.breaksGenerator(TimeBreaksGen())
} else if (!discreteDomain && has(Option.Scale.CONTINUOUS_TRANSFORM)) {
val transformName = getStringSafe(Option.Scale.CONTINUOUS_TRANSFORM)
val transform = when (transformName.lowercase()) {
TransformName.IDENTITY -> Transforms.IDENTITY
TransformName.LOG10 -> Transforms.LOG10
TransformName.LOG2 -> Transforms.LOG2
TransformName.SYMLOG -> Transforms.SYMLOG
TransformName.REVERSE -> Transforms.REVERSE
TransformName.SQRT -> Transforms.SQRT
else -> throw IllegalArgumentException(
"Unknown transform name: '$transformName'. Supported: ${
listOf(
TransformName.IDENTITY,
TransformName.LOG10,
TransformName.LOG2,
TransformName.SYMLOG,
TransformName.REVERSE,
TransformName.SQRT
).joinToString(transform = { "'$it'" })
}."
)
}
b.continuousTransform(transform)
}
if (aes in listOf<Aes<*>>(Aes.X, Aes.Y) && has(Option.Scale.POSITION)) {
b.axisPosition = axisPosition(aes)
}
return applyCommons(b)
}
private fun applyCommons(b: ScaleProviderBuilder<T>): ScaleProviderBuilder<T> {
if (has(NAME)) {
b.name(getString(NAME)!!)
}
if (has(BREAKS)) {
b.breaks(getList(BREAKS).mapNotNull { it })
}
if (has(LABELS)) {
b.labels(getStringList(LABELS))
} else {
// Skip format is labels are defined
b.labelFormat(getString(FORMAT))
}
if (has(LABLIM)) {
b.labelLengthLimit(getInteger(LABLIM)!!)
}
if (has(EXPAND)) {
val expandList = getDoubleList(EXPAND)
expandList.getOrNull(0)?.let {
b.multiplicativeExpand(it)
}
expandList.getOrNull(1)?.let {
b.additiveExpand(it)
}
}
if (has(LIMITS)) {
b.limits(this.getList(LIMITS))
}
return b
}
fun hasGuideOptions(): Boolean {
return has(GUIDE)
}
fun getGuideOptions(): GuideConfig {
return GuideConfig.create(get(GUIDE)!!)
}
private fun axisPosition(axis: Aes<*>): AxisPosition {
val s = getStringSafe(Option.Scale.POSITION)
return when (s.trim().lowercase()) {
Option.Scale.POSITION_L -> AxisPosition.LEFT
Option.Scale.POSITION_R -> AxisPosition.RIGHT
Option.Scale.POSITION_T -> AxisPosition.TOP
Option.Scale.POSITION_B -> AxisPosition.BOTTOM
Option.Scale.POSITION_BOTH -> {
if (axis == Aes.X) AxisPosition.TB
else AxisPosition.LR
}
else -> throw IllegalArgumentException("'${Option.Scale.POSITION}' - unexpected value: '$s'. Valid values: left|right|top|bottom|both.")
}
}
companion object {
fun aesOrFail(options: Map<String, Any>): Aes<*> {
val accessor = OptionsAccessor(options)
require(accessor.has(AES)) { "Required parameter '$AES' is missing" }
return Option.Mapping.toAes(accessor.getStringSafe(AES))
}
fun <T> createIdentityMapperProvider(
aes: Aes<T>,
naValue: T,
aopConversion: AesOptionConversion
): MapperProvider<T> {
// There is an option value converter for every AES (which can be used as discrete identity mapper)
val discreteMapperProvider =
IdentityDiscreteMapperProvider(aopConversion.getConverter(aes))
// For some AES there is also a continuous identity mapper
if (TypedContinuousIdentityMappers.contain(aes)) {
val continuousMapper = TypedContinuousIdentityMappers[aes]
return IdentityMapperProvider(
discreteMapperProvider,
ScaleMapper.wrap(continuousMapper, naValue)
)
}
return discreteMapperProvider
}
}
}